Overview
Configuration is provided for establishing connections with the Zuora service. The configuration is used in the REST Connection Manager.
Setup
Press 
icon to get more information about the connection parameters.
Obtain data
Use REST Source component to get data from service resource.
Insert data
Use REST Destination component to insert data into service resource.
Configuration
Base URL address: https://rest.zuora.com/v1.
- Token
-
The authentication uses a session token.
The authentication has the following user-defined parameters:
- client_id: Required. Specify client identifier.
- client_secret: Required. Specify client secret.
The following request parameters will be automatically processed during the authentication process:
-
Authorization:
Bearer {{=token.Access}}
Documentation: https://www.zuora.com/developer/api-reference/#section/Authentication.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/accounting-codes.
The result is extracted from:{{=response.accountingCodes}}.Documentation: https://www.zuora.com/developer/api-reference/#operation/GET_AllAccountingCodes.
- [Create] action
-
Endpoint URL address:
/accounting-codes.Documentation: https://www.zuora.com/developer/api-reference/#operation/POST_AccountingCode.
- [Update] action
-
Endpoint URL address:
/accounting-codes/{{=item.id}}.Documentation: https://www.zuora.com/developer/api-reference/#operation/PUT_AccountingCode.
- [Delete] action
-
Endpoint URL address:
/accounting-codes/{{=item.id}}.Documentation: https://www.zuora.com/developer/api-reference/#operation/DELETE_AccountingCode.
- id
A key field. Template: ShortText.
- name
Template: ShortText.
- type
Template: ShortText.
- glAccountName
Template: ShortText.
- glAccountNumber
Template: ShortText.
- notes
Template: LongText.
- category
Template: ShortText.
- status
Template: ShortText.
- CustomField__c
Template: ShortText.
- createdOn
Template: DateTime. A read-only field.
- createdBy
Template: ShortText. A read-only field.
- updatedOn
Template: DateTime. A read-only field.
- updatedBy
Template: ShortText. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/accounting-periods.
The result is extracted from:{{=response.accountingPeriods}}.Documentation: https://www.zuora.com/developer/api-reference/#operation/GET_AllAccountingPeriods.
- [Create] action
-
Endpoint URL address:
/accounting-periods.Documentation: https://www.zuora.com/developer/api-reference/#operation/POST_AccountingPeriod.
- [Update] action
-
Endpoint URL address:
/accounting-periods/{{=item.id}}.Documentation: https://www.zuora.com/developer/api-reference/#operation/PUT_UpdateAccountingPeriod.
- [Delete] action
-
Endpoint URL address:
/accounting-periods/{{=item.id}}.Documentation: https://www.zuora.com/developer/api-reference/#operation/DELETE_AccountingPeriod.
- id
A key field. Template: ShortText.
- name
Template: ShortText.
- startDate
Template: Date.
- endDate
Template: Date.
- status
Template: ShortText.
- runTrialBalanceStatus
Template: ShortText.
- runTrialBalanceStart
Template: DateTime.
- runTrialBalanceEnd
Template: DateTime.
- runTrialBalanceErrorMessage
Template: ShortText.
- fiscalYear
Data type: DT_I4
- notes
Template: LongText.
- fileIds
A read-only field. The gathered value is processed with
{{=_.map(item.fileIds, function(v, k) { return { name: k, value: v }; })}}expression. Field components:- An array.
- Contains the following components: name, value.
- createdOn
Template: DateTime. A read-only field.
- createdBy
Template: ShortText. A read-only field.
- updatedOn
Template: DateTime. A read-only field.
- updatedBy
Template: ShortText. A read-only field.
Based on resource template Base.
- [Read] action
-
The result is extracted from:{{=_.map(parameters.key_list.split(','), function(key) { return connection.execute({ url: '/accounts/' + key }); })}}.The action has the following user-defined parameters:
- key_list: Required. Specify comma (,) separated list of account numbers or identifiers.
The following request parameters will be automatically processed:
-
pageSize:
- [Create] action
-
Endpoint URL address:
/accounts.Documentation: https://www.zuora.com/developer/api-reference/#operation/POST_Account.
- [Update] action
-
Endpoint URL address:
/accounts/{{=item.id}}.Documentation: https://www.zuora.com/developer/api-reference/#operation/PUT_Account.
- [Delete] action
-
Endpoint URL address:
/accounts/{{=item.id}}.
- id
A key field. Template: ShortText. The gathered value is processed with
{{=item.basicInfo.id}}expression.- accountNumber
Template: ShortText.
- additionalEmailAddresses
Template: LongText. A composite field.
- applyCreditBalance
Data type: DT_BOOL
- autoPay
Data type: DT_BOOL
- batch
Template: ShortText.
- billCycleDay
Data type: DT_I4
- billToContact
Template: Contact.
- collect
Template: ShortText.
- communicationProfileId
Template: ShortText.
- creditCard
Field components:
-
Uses template:
ShortText. - Contains the following components: cardHolderInfo, cardNumber, cardType, expirationMonth, expirationYear, securityCode.
-
Uses template:
- crmId
Template: ShortText.
- currency
Template: ShortText.
- customField__c
Template: ShortText.
- hpmCreditCardPaymentMethodId
Template: ShortText.
- invoice
Data type: DT_BOOL
- invoiceCollect
Data type: DT_BOOL
- invoiceDeliveryPrefsEmail
Data type: DT_BOOL
- invoiceDeliveryPrefsPrint
Data type: DT_BOOL
- invoiceTemplateId
Template: ShortText.
- name
Template: ShortText.
- notes
Template: LongText.
- paymentGateway
Template: ShortText.
- paymentTerm
Template: ShortText.
- runBilling
Data type: DT_BOOL
- soldToContact
Template: Contact.
- subscription
Template: SubscriptionT. Field components:
-
Uses template:
ShortText. - Contains the following components: invoiceOwnerAccountKey.
-
Uses template:
- tagging
Template: ShortText.
- targetDate
Template: Date.
- taxInfo
Field components:
-
Uses template:
ShortText. - Contains the following components: VATId, companyCode, exemptCertificateId, exemptCertificateType, exemptDescription, exemptEffectiveDate, exemptExpirationDate, exemptIssuingJurisdiction, exemptStatus.
-
Uses template:
- basicInfo
A read-only field. Field components:
-
Uses template:
ShortText. - Contains the following components: id, name, accountNumber, notes, status, crmId, batch, invoiceTemplateId, communicationProfileId.
-
Uses template:
- billingAndPayment
A read-only field. Field components:
-
Uses template:
ShortText. - Contains the following components: billCycleDay, currency, paymentTerm, paymentGateway, invoiceDeliveryPrefsPrint, invoiceDeliveryPrefsEmail, additionalEmailAddresses.
-
Uses template:
- metrics
A read-only field. Field components:
- Contains the following components: balance, totalInvoiceBalance, creditBalance, contractedMrr.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/attachments/{{=parameters.objectType}}/{{=parameters.objectKey}}.
The result is extracted from:{{=response.attachments}}.The action has the following user-defined parameters:
- objectType: Required. Specify object type: account, invoice, subscription
- objectKey: Required. Specify object identifier.
Documentation: https://www.zuora.com/developer/api-reference/#operation/GET_AttachmentsList.
- [Create] action
-
Endpoint URL address:
/attachments.The following request parameters will be automatically processed:
-
application/json:
-
description:
{{=item.description}} -
associatedObjectType:
{{=item.objectType}} -
associatedObjectKey:
{{=item.objectKey}} -
file:
{{=item.content}}
Documentation: https://www.zuora.com/developer/api-reference/#operation/POST_Attachments.
-
application/json:
- [Update] action
-
Endpoint URL address:
/attachments/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
-
description:
{{=item.description}} -
fileName:
{{=item.fileName}}
Documentation: https://www.zuora.com/developer/api-reference/#operation/PUT_Attachments.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/attachments/{{=item.id}}.Documentation: https://www.zuora.com/developer/api-reference/#operation/DELETE_Attachments.
- id
A key field. Template: ShortText.
- fileName
Template: ShortText.
- description
Template: LongText.
- fileId
Template: ShortText. A read-only field.
- fileContentType
Template: ShortText. A read-only field.
- createdOn
Template: DateTime. A read-only field.
- createdBy
Template: ShortText. A read-only field.
- updatedOn
Template: DateTime. A read-only field.
- updatedBy
Template: ShortText. A read-only field.
- objectType
Template: ShortText.
- objectKey
Template: ShortText.
- content
-
Data type: DT_IMAGE The value is gathered from
/files/{{=item.fileId}}address.Documentation: https://www.zuora.com/developer/api-reference/#tag/Get-Files.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/catalog/products.
The result is extracted from:{{=response.products}}.Documentation: https://www.zuora.com/developer/api-reference/#operation/GET_Catalog.
- id
A key field. Template: ShortText.
- sku
Template: ShortText.
- name
Template: ShortText.
- description
Template: LongText.
- category
Template: ShortText.
- effectiveStartDate
Template: Date.
- effectiveEndDate
Template: Date.
- productRatePlans
Field components:
- An array.
-
Uses template:
ProductRatePlan.
Based on resource template Base.
- [Create] action
-
Endpoint URL address:
/object/contact.Documentation: https://www.zuora.com/developer/api-reference/#operation/Object_POSTContact.
- [Update] action
-
Endpoint URL address:
/object/contact/{{=item.Id}}.Documentation: https://www.zuora.com/developer/api-reference/#operation/Object_PUTContact.
- [Delete] action
-
Endpoint URL address:
/object/contact/{{=item.Id}}.Documentation: https://www.zuora.com/developer/api-reference/#operation/Object_DELETEContact.
- Id
A key field. Template: ShortText.
- AccountId
Template: ShortText.
- Address1
Template: ShortText.
- City
Template: ShortText.
- Country
Template: ShortText.
- Description
Template: LongText.
- Fax
Template: ShortText.
- FirstName
Template: ShortText.
- HomePhone
Template: ShortText.
- LastName
Template: ShortText.
- MobilePhone
Template: ShortText.
- NickName
Template: ShortText.
- OtherPhone
Template: ShortText.
- OtherPhoneType
Template: ShortText.
- PersonalEmail
Template: ShortText.
- PostalCode
Template: ShortText.
- State
Template: ShortText.
- TaxRegion
Template: ShortText.
- WorkEmail
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/creditmemos.
The result is extracted from:{{=response.creditmemos}}.Documentation: https://www.zuora.com/developer/api-reference/#operation/GET_CreditMemos.
- [Read account] action
-
Endpoint URL address:
/creditmemos/query.
The result is extracted from:{{=response.creditmemos}}.The action has the following user-defined parameters:
- account: Required. Specify account identifier (alias for "accountId").
The following request parameters will be automatically processed:
-
accountId:
{{=parameters.account}}
Documentation: https://www.zuora.com/developer/api-reference/#operation/POST_QueryCreditMemos.
- [Create] action
-
Endpoint URL address:
/creditmemos.Documentation: https://www.zuora.com/developer/api-reference/#operation/POST_CreditMemoFromPrpc.
- [Update] action
-
Endpoint URL address:
/creditmemos/{{=item.id}}.Documentation: https://www.zuora.com/developer/api-reference/#operation/PUT_UpdateCreditMemo.
- [Delete] action
-
Endpoint URL address:
/creditmemos/{{=item.id}}.Documentation: https://www.zuora.com/developer/api-reference/#operation/DELETE_CreditMemo.
- id
A key field. Template: ShortText.
- number
Template: ShortText. A read-only field.
- accountId
Template: ShortText.
- currency
Template: ShortText.
- creditMemoDate
Template: Date. A read-only field.
- targetDate
Template: Date. A read-only field.
- postedById
Template: ShortText. A read-only field.
- postedOn
Template: DateTime. A read-only field.
- status
Template: ShortText. A read-only field.
- amount
Data type: DT_R8
- taxAmount
Data type: DT_R8
- totalTaxExemptAmount
Data type: DT_R8
- unappliedAmount
Data type: DT_R8
- refundAmount
Data type: DT_R8
- appliedAmount
Data type: DT_R8
- comment
Template: ShortText.
- source
Template: ShortText. A read-only field.
- sourceId
Template: ShortText. A read-only field.
- referredInvoiceId
Template: ShortText. A read-only field.
- reasonCode
Template: ShortText.
- createdDate
Template: DateTime. A read-only field.
- createdById
Template: ShortText. A read-only field.
- updatedDate
Template: DateTime. A read-only field.
- updatedById
Template: ShortText. A read-only field.
- latestPDFFileId
Template: ShortText. A read-only field.
- transferredToAccounting
Template: ShortText.
- excludeFromAutoApplyRules
Data type: DT_BOOL
- autoApplyUponPosting
Data type: DT_BOOL
- customField__c
Template: ShortText.
- indexedCustomFiled1__c
Template: ShortText.
- effectiveDate
Template: Date.
- charges
Field components:
- An array.
- Contains the following components: chargeId, comment, financeInformation, memoItemAmount, serviceEndDate, serviceStartDate.
- items
A read-only field. The value is gathered from
/creditmemos/{{=item.id}}/itemsaddress. The value is sent to/invoices/{{=item.referredInvoiceId}}/creditmemosaddress. Field components:- An array.
- Contains the following components: id, amount, comment, serviceEndDate, serviceStartDate, skuName, taxItems, unitOfMeasure.
- parts
The value is gathered from
/creditmemos/{{=item.id}}/partsaddress. Field components:- An array.
- Contains the following components: id, invoiceId, debitMemoId, amount, createdDate, createdById, updatedDate, updatedById.
- [Read] action
-
Endpoint URL address:
/custom-exchange-rates/{{=parameters.currency}}.
The result is extracted from:{{=_.map(response.rates, function(v, k) { return _.extend({ date: k }, v); })}}.The action has the following user-defined parameters:
- currency: Required. Specify target base currency.
- date
Template: Date.
- providerExchangeRateDate
Template: Date.
- JPY
Data type: DT_R8
- EUR
Data type: DT_R8
- GBP
Data type: DT_R8
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/debitmemos.
The result is extracted from:{{=response.debitmemos}}.Documentation: https://www.zuora.com/developer/api-reference/#operation/GET_DebitMemos.
- [Create] action
-
Endpoint URL address:
/debitmemos.Documentation: https://www.zuora.com/developer/api-reference/#operation/POST_DebitMemoFromPrpc.
- [Update] action
-
Endpoint URL address:
/debitmemos/{{=item.id}}.Documentation: https://www.zuora.com/developer/api-reference/#operation/PUT_DebitMemo.
- [Delete] action
-
Endpoint URL address:
/debitmemos/{{=item.id}}.Documentation: https://www.zuora.com/developer/api-reference/#operation/DELETE_DebitMemo.
- id
A key field. Template: ShortText.
- number
Template: ShortText.
- accountId
Template: ShortText.
- debitMemoDate
Template: Date.
- targetDate
Template: Date.
- dueDate
Template: Date.
- postedOn
Template: Date. A read-only field.
- postedById
Template: ShortText. A read-only field.
- status
Template: ShortText.
- amount
Data type: DT_R8
- taxAmount
Data type: DT_R8
- totalTaxExemptAmount
Data type: DT_R8
- balance
Data type: DT_R8
- beAppliedAmount
Data type: DT_R8
- comment
Template: ShortText.
- referredInvoiceId
Template: ShortText.
- transferredToAccounting
Template: ShortText.
- reasonCode
Template: ShortText.
- createdDate
Template: DateTime. A read-only field.
- createdById
Template: ShortText. A read-only field.
- updatedDate
Template: DateTime. A read-only field.
- updatedById
Template: ShortText. A read-only field.
- cancelledOn
Template: Date. A read-only field.
- cancelledById
Template: ShortText. A read-only field.
- latestPDFFileId
Template: ShortText. A read-only field.
- effectiveDate
Template: Date.
- charges
Field components:
- An array.
- Contains the following components: chargeId, comment, memoItemAmount.
- items
-
A read-only field. The value is gathered from
/debitmemos/{{=item.id}}/itemsaddress. The value is sent to/invoices/{{=item.referredInvoiceId}}/debitmemosaddress. Field components:- An array.
- Contains the following components: id, amount, beAppliedAmount, balance, sku, skuName, serviceStartDate, serviceEndDate, sourceItemType, sourceItemId, createdDate, createdById, updatedDate, updatedById, comment, subscriptionId, financeInformation, taxItems, invoiceItemId, unitOfMeasure.
Documentation: https://www.zuora.com/developer/api-reference/#operation/GET_DebitMemoItems.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/entities.
The result is extracted from:{{=response.entities}}.Documentation: https://www.zuora.com/developer/api-reference/#operation/GET_Entities.
- [Read username] action
-
Endpoint URL address:
/users/{{=parameters.username}}/accessible-entities.
The result is extracted from:{{=response.entities}}.The action has the following user-defined parameters:
- username: Required. Specify user name.
Documentation: https://www.zuora.com/developer/api-reference/#operation/GET_EntitiesUserAccessible.
- [Create] action
-
Endpoint URL address:
/entities.Documentation: https://www.zuora.com/developer/api-reference/#operation/POST_Entities.
- [Update] action
-
Endpoint URL address:
/entities/{{=item.id}}.Documentation: https://www.zuora.com/developer/api-reference/#operation/PUT_Entities.
- [Delete] action
-
Endpoint URL address:
/entities/{{=item.id}}.Documentation: https://www.zuora.com/developer/api-reference/#operation/DELETE_Entities.
- id
A key field. Template: ShortText.
- name
Template: ShortText.
- displayName
Template: ShortText.
- locale
Template: ShortText.
- timezone
Template: ShortText.
- status
Template: ShortText. A read-only field.
- parentId
Template: ShortText.
- tenantId
Template: ShortText. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/entity-connections.
The result is extracted from:{{=response.entityConnections}}.Documentation: https://www.zuora.com/developer/api-reference/#operation/GET_EntityConnections.
- [Create] action
-
Endpoint URL address:
/entity-connections.Documentation: https://www.zuora.com/developer/api-reference/#operation/POST_EntityConnections.
- [Delete] action
-
Endpoint URL address:
/entity-connections/{{=item.id}}/disconnect.
The action uses PUT method.Documentation: https://www.zuora.com/developer/api-reference/#operation/PUT_EntityConnectionsDisconnect.
- id
A key field. Template: ShortText.
- sourceEntityId
Template: ShortText. A read-only field.
- targetEntityId
Template: ShortText.
- status
Template: ShortText. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/hostedpages.
The result is extracted from:{{=response.hostedpages}}.
- pageId
Template: ShortText.
- pageType
Template: ShortText.
- pageVersion
Data type: DT_I4
Based on resource template Base.
- [Create] action
-
Endpoint URL address:
/object/invoice-adjustment.Documentation: https://www.zuora.com/developer/api-reference/#operation/Object_POSTInvoiceAdjustment.
- [Update] action
-
Endpoint URL address:
/object/invoice-adjustment/{{=item.id}}.Documentation: https://www.zuora.com/developer/api-reference/#operation/Object_PUTInvoiceAdjustment.
- [Delete] action
-
Endpoint URL address:
/object/invoice-adjustment/{{=item.id}}.Documentation: https://www.zuora.com/developer/api-reference/#operation/Object_DELETEInvoiceAdjustment.
- id
A key field. Template: ShortText.
- accountingCode
Template: ShortText.
- adjustmentDate
Template: Date.
- amount
Data type: DT_R8
- comments
Template: ShortText.
- invoiceId
Template: ShortText.
- invoiceNumber
Template: ShortText.
- referenceId
Template: ShortText.
- type
Template: ShortText.
- reasonCode
Template: ShortText.
- status
Template: ShortText.
- transferredToAccounting
Template: ShortText.
Based on resource template Base.
- [Create] action
-
Endpoint URL address:
/object/invoice-payment.Documentation: https://www.zuora.com/developer/api-reference/#operation/Object_POSTInvoicePayment.
- [Update] action
-
Endpoint URL address:
/object/invoice-payment/{{=item.id}}.Documentation: https://www.zuora.com/developer/api-reference/#operation/Object_PUTInvoicePayment.
- id
A key field. Template: ShortText.
- amount
Data type: DT_R8
- invoiceId
Template: ShortText.
- paymentId
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/transactions/invoices/accounts/{{=parameters.accountKey}}.
The result is extracted from:{{=response.invoices}}.The action has the following user-defined parameters:
- accountKey: Required. Specify account identifier.
Documentation: https://www.zuora.com/developer/api-reference/#operation/GET_TransactionInvoice.
- [Update] action
-
Endpoint URL address:
/object/invoice/{{=item.id}}.Documentation: https://www.zuora.com/developer/api-reference/#operation/Object_PUTInvoice.
- [Delete] action
-
Endpoint URL address:
/object/invoice/{{=item.id}}.Documentation: https://www.zuora.com/developer/api-reference/#operation/Object_DELETEInvoice.
- id
A key field. Template: ShortText.
- accountId
Template: ShortText.
- accountNumber
Template: ShortText.
- accountName
Template: ShortText.
- invoiceDate
Template: Date.
- invoiceNumber
Template: ShortText.
- dueDate
Template: Date.
- invoiceTargetDate
Template: Date.
- amount
Data type: DT_R8
- balance
Data type: DT_R8
- createdBy
Template: ShortText. A read-only field.
- status
Template: ShortText.
- transferredToAccounting
Template: ShortText.
- body
Template: LongText.
- invoiceItems
Field components:
- An array.
- Contains the following components: id, subscriptionName, subscriptionId, serviceStartDate, serviceEndDate, chargeAmount, chargeDescription, chargeName, chargeId, productName, quantity, taxAmount, unitOfMeasure.
- invoiceFiles
Template: LongText. A composite field.
Based on resource template Base.
- [Create] action
-
Endpoint URL address:
/journal-runs.Documentation: https://www.zuora.com/developer/api-reference/#operation/POST_JournalRun.
- [Delete] action
-
Endpoint URL address:
/journal-runs/{{=item.journalRunNumber}}.Documentation: https://www.zuora.com/developer/api-reference/#operation/DELETE_JournalRun.
- journalRunNumber
A key field. Template: ShortText.
- accountingPeriodName
Template: ShortText.
- journalEntryDate
Template: Date.
- transactionTypes
Template: LongText. A composite field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/notification-history/callout.
The result is extracted from:{{=response.calloutHistories}}.
- responseCode
Template: ShortText.
- requestUrl
Template: ShortText.
- requestMethod
Template: ShortText.
- eventCategory
Data type: DT_I4
- notification
Template: ShortText.
- attemptedNum
Data type: DT_I4
- createTime
Template: DateTime.
- eventContext
Template: LongText. A composite field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/notification-history/email.
The result is extracted from:{{=response.emailHistories}}.
- result
Template: ShortText.
- errorMessage
Template: ShortText.
- eventCategory
Data type: DT_I4
- notification
Template: ShortText.
- subject
Template: ShortText.
- toEmail
Template: ShortText.
- fromEmail
Template: ShortText.
- cc
Template: ShortText.
- bcc
Template: ShortText.
- replyTo
Template: ShortText.
- sendTime
Template: DateTime.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/orders.
The result is extracted from:{{=response.orders}}.Documentation: https://www.zuora.com/developer/api-reference/#operation/GET_AllOrders.
- [Read invoiceOwner] action
-
Endpoint URL address:
/orders/invoiceOwner/{{=parameters.invoiceOwner}}.
The result is extracted from:{{=response.orders}}.The action has the following user-defined parameters:
- invoiceOwner: Required. Specify invoice owner.
Documentation: https://www.zuora.com/developer/api-reference/#operation/GET_OrdersByInvoiceOwner.
- [Read subscriptionOwner] action
-
Endpoint URL address:
/orders/subscriptionOwner/{{=parameters.subscriptionOwner}}.
The result is extracted from:{{=response.orders}}.The action has the following user-defined parameters:
- subscriptionOwner: Required. Specify subscription owner.
Documentation: https://www.zuora.com/developer/api-reference/#operation/GET_OrdersBySubscriptionOwner.
- [Read subscriptionNumber] action
-
Endpoint URL address:
/orders/subscription/{{=parameters.subscriptionNumber}}.
The result is extracted from:{{=response.orders}}.The action has the following user-defined parameters:
- subscriptionNumber: Required. Specify subscription number.
Documentation: https://www.zuora.com/developer/api-reference/#operation/GET_OrdersBySubscriptionNumber.
- orderNumber
A key field. Template: ShortText.
- orderDate
Template: Date.
- createdDate
Template: Date. A read-only field.
- createdBy
Template: ShortText. A read-only field.
- updatedDate
Template: DateTime. A read-only field.
- updatedById
Template: ShortText. A read-only field.
- existingAccountNumber
Template: ShortText.
- currency
Template: ShortText.
- status
Template: ShortText.
- customFields
Template: LongText. A composite field.
- subscriptions
Field components:
- An array.
- Contains the following components: subscriptionNumber, customFields, baseVersion, newVersion, orderActions, updateProduct.
- billingInfo
The value is gathered from
/orders/{{=item.orderNumber}}/billingInfoaddress. Field components:-
Uses template:
ShortText. - Contains the following components: currency, tcb, billedAmount, unbilledAmount.
-
Uses template:
- ratedResults
The value is gathered from
/orders/{{=item.orderNumber}}/ratedResultsaddress. The gathered value is processed with{{=response.orderRatedResult.subscriptionRatedResults}}expression. Field components:- An array.
- Contains the following components: subscriptionNumber, chargeRatedResults.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/paymentgateways.
The result is extracted from:{{=response.paymentgateways}}.
- id
A key field. Template: ShortText.
- name
Template: ShortText.
- type
Template: ShortText.
- isDefault
Data type: DT_BOOL
- isActive
Data type: DT_BOOL
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/payment-methods/credit-cards/accounts/{{=parameters.accountKey}}.
The result is extracted from:{{=response.creditCards}}.The action has the following user-defined parameters:
- accountKey: Required. Specify account identifier.
Documentation: https://www.zuora.com/developer/api-reference/#operation/GET_PaymentMethods.
- [Create] action
-
Endpoint URL address:
/payment-methods/credit-cards.Documentation: https://www.zuora.com/developer/api-reference/#operation/POST_PaymentMethods.
- [Update] action
-
Endpoint URL address:
/payment-methods/credit-cards/{{=item.id}}.Documentation: https://www.zuora.com/developer/api-reference/#operation/PUT_PaymentMethods.
- [Delete] action
-
Endpoint URL address:
/payment-methods/credit-cards/{{=item.id}}.Documentation: https://www.zuora.com/developer/api-reference/#operation/DELETE_PaymentMethods.
- id
A key field. Template: ShortText.
- cardHolderInfo
Field components:
-
Uses template:
ShortText. - Contains the following components: zipCode, addressLine2, addressLine1, phone, state, country, city, cardHolderName, email.
-
Uses template:
- defaultPaymentMethod
Data type: DT_BOOL
- expirationMonth
Data type: DT_I4
- cardNumber
Template: ShortText.
- expirationYear
Data type: DT_I4
- cardType
Template: ShortText.
- accountKey
Template: ShortText.
- numConsecutiveFailures
Data type: DT_I4
- securityCode
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/payments.Documentation: https://www.zuora.com/developer/api-reference/#operation/GET_RetrieveAllPayments.
- [Read accountKey] action
-
Endpoint URL address:
/transactions/payments/accounts/{{=parameters.accountKey}}.The action has the following user-defined parameters:
- accountKey: Required. Specify account identifier.
- [Create] action
-
Endpoint URL address:
/payments.Documentation: https://www.zuora.com/developer/api-reference/#operation/POST_CreatePayment.
- [Update] action
-
Endpoint URL address:
/payments/{{=item.id}}.Documentation: https://www.zuora.com/developer/api-reference/#operation/PUT_UpdatePayment.
- [Delete] action
-
Endpoint URL address:
/payments/{{=item.id}}.Documentation: https://www.zuora.com/developer/api-reference/#operation/DELETE_Payment.
- id
A key field. Template: ShortText.
- number
Template: ShortText.
- status
Template: ShortText.
- type
Template: ShortText.
- accountId
Template: ShortText.
- amount
Data type: DT_R8
- appliedAmount
Data type: DT_R8
- unappliedAmount
Data type: DT_R8
- refundAmount
Data type: DT_R8
- creditBalanceAmount
Data type: DT_R8
- currency
Template: ShortText.
- effectiveDate
Template: Date.
- comment
Template: ShortText.
- paymentMethodId
Template: ShortText.
- paymentMethodSnapshotId
Template: ShortText.
- authTransactionId
Template: ShortText.
- bankIdentificationNumber
Template: ShortText.
- gatewayId
Template: ShortText.
- gatewayOrderId
Template: ShortText.
- gatewayResponse
Template: ShortText.
- gatewayResponseCode
Template: ShortText.
- gatewayState
Template: ShortText.
- markedForSubmissionOn
Template: Date.
- referenceId
Template: ShortText.
- secondPaymentReferenceId
Template: ShortText.
- softDescriptor
Template: ShortText.
- softDescriptorPhone
Template: ShortText.
- submittedOn
Template: Date.
- settledOn
Template: Date.
- cancelledOn
Template: Date.
- createdDate
Template: DateTime. A read-only field.
- createdById
Template: ShortText. A read-only field.
- updatedDate
Template: DateTime. A read-only field.
- updatedById
Template: ShortText. A read-only field.
- custom_field_picklist__c
Template: ShortText.
- financeInformation
Template: PaymentFinanceInformation.
- debitMemos
Field components:
- An array.
- Contains the following components: amount, debitMemoId, items.
- invoices
Field components:
- An array.
- Contains the following components: amount, invoiceId, items.
- parts
The value is gathered from
/payments/{{=item.id}}/partsaddress. Field components:- An array.
- Contains the following components: id, debitMemoId, invoiceId, amount, createdDate, createdById, updatedDate, updatedById, items.
Based on resource template Base.
- [Create] action
-
Endpoint URL address:
/object/product-rate-plan.Documentation: https://www.zuora.com/developer/api-reference/#operation/Object_POSTProductRatePlan.
- [Update] action
-
Endpoint URL address:
/object/product-rate-plan/{{=item.id}}.Documentation: https://www.zuora.com/developer/api-reference/#operation/Object_PUTProductRatePlan.
- [Delete] action
-
Endpoint URL address:
/object/product-rate-plan/{{=item.id}}.Documentation: https://www.zuora.com/developer/api-reference/#operation/Object_DELETEProductRatePlan.
- id
A key field. Template: ShortText.
- description
Template: ShortText.
- effectiveEndDate
Template: Date.
- effectiveStartDate
Template: Date.
- name
Template: ShortText.
- productId
Template: ShortText.
Based on resource template Base.
- [Create] action
-
Endpoint URL address:
https://www.zuora.com/developer/api-reference/#operation/Object_POSTProduct.Documentation: https://www.zuora.com/developer/api-reference/#operation/Object_POSTProduct.
- [Update] action
-
Endpoint URL address:
/object/product/{{=item.id}}.Documentation: https://www.zuora.com/developer/api-reference/#operation/Object_PUTProduct.
- [Delete] action
-
Endpoint URL address:
/object/product/{{=item.id}}.Documentation: https://www.zuora.com/developer/api-reference/#operation/Object_DELETEProduct.
- id
A key field. Template: ShortText.
- description
Template: ShortText.
- effectiveEndDate
Template: Date.
- effectiveStartDate
Template: Date.
- name
Template: ShortText.
- sku
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/refunds.
The result is extracted from:{{=response.refunds}}.Documentation: https://www.zuora.com/developer/api-reference/#operation/GET_Refunds.
- [Create] action
-
Endpoint URL address:
/refunds.
- [Update] action
-
Endpoint URL address:
/refunds/{{=item.id}}.Documentation: https://www.zuora.com/developer/api-reference/#operation/PUT_UpdateRefund.
- [Delete] action
-
Endpoint URL address:
/refunds/{{=item.id}}.Documentation: https://www.zuora.com/developer/api-reference/#operation/DELETE_Refund.
- id
A key field. Template: ShortText.
- number
Template: ShortText.
- status
Template: ShortText.
- type
Template: ShortText.
- methodType
Template: ShortText.
- accountId
Template: ShortText.
- amount
Data type: DT_R8
- refundDate
Template: Date.
- comment
Template: ShortText.
- paymentMethodId
Template: ShortText.
- paymentMethodSnapshotId
Template: ShortText.
- paymentId
Template: ShortText.
- creditMemoId
Template: ShortText.
- reasonCode
Template: ShortText.
- gatewayId
Template: ShortText.
- gatewayResponse
Template: ShortText.
- gatewayResponseCode
Template: ShortText.
- gatewayState
Template: ShortText.
- markedForSubmissionOn
Template: Date.
- referenceId
Template: ShortText.
- secondRefundReferenceId
Template: ShortText.
- softDescriptor
Template: ShortText.
- softDescriptorPhone
Template: ShortText.
- submittedOn
Template: Date.
- settledOn
Template: Date.
- cancelledOn
Template: Date.
- createdDate
Template: DateTime. A read-only field.
- createdById
Template: ShortText. A read-only field.
- updatedDate
Template: DateTime. A read-only field.
- updatedById
Template: ShortText. A read-only field.
- refundTransactionTime
Template: DateTime.
- financeInformation
Template: PaymentFinanceInformation.
- parts
The value is gathered from
/refunds/{{=item.id}}/partsaddress. Field components:- An array.
- Contains the following components: id, paymentId, creditMemoId, amount, createdDate, createdById, updatedDate, updatedById, items.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/revenue-events/revenue-schedules/{{=parameters.rsNumber}}.
The result is extracted from:{{=response.revenueEventDetails}}.The action has the following user-defined parameters:
- rsNumber: Required. Specify revenue schedule number.
- number
Template: ShortText.
- currency
Template: ShortText.
- notes
Template: ShortText.
- accountId
Template: ShortText.
- subscriptionId
Template: ShortText.
- subscriptionChargeId
Template: ShortText.
- createdOn
Template: DateTime.
- eventType
Template: ShortText.
- recognitionStart
Template: Date.
- recognitionEnd
Template: Date.
- cf_phases__c
Template: ShortText.
- cf_project__c
Template: ShortText.
- revenueItems
Field components:
- An array.
- Contains the following components: accountingPeriodName, isAccountingPeriodClosed, amount, currency, accountingPeriodStartDate, accountingPeriodEndDate.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/subscriptions/accounts/{{=parameters.accountKey}}.
The result is extracted from:{{=response.subscriptions}}.The action has the following user-defined parameters:
- accountKey: Required. Specify account identifier.
Documentation: https://www.zuora.com/developer/api-reference/#operation/GET_SubscriptionsByAccount.
- [Create] action
-
Endpoint URL address:
/subscriptions.Documentation: https://www.zuora.com/developer/api-reference/#operation/POST_Subscription.
- [Update] action
-
Endpoint URL address:
/subscriptions/{{=item.id}}.Documentation: https://www.zuora.com/developer/api-reference/#operation/PUT_Subscription.
- [Delete] action
-
Endpoint URL address:
/object/subscription/{{=item.id}}.
The resource includes the fields from the SubscriptionT template.
- ratePlans
Field components:
- An array.
- Contains the following components: id, productId, productName, productSku, productRatePlanId, ratePlanName, ratePlanCharges.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/journal-entries/journal-runs/{{=parameters.jrNumber}}.
The result is extracted from:{{=response.journalEntries}}.The action has the following user-defined parameters:
- jrNumber: Required. Specify journal run number.
Documentation: https://www.zuora.com/developer/api-reference/#operation/GET_AllSummaryJournalEntries.
- [Create] action
-
Endpoint URL address:
/journal-entries.Documentation: https://www.zuora.com/developer/api-reference/#operation/POST_SummaryJournalEntry.
- [Update] action
-
Endpoint URL address:
/journal-entries/{{=item.number}}/basic-information.Documentation: https://www.zuora.com/developer/api-reference/#operation/PUT_BasicSummaryJournalEntry.
- [Delete] action
-
Endpoint URL address:
/journal-entries/{{=item.number}}.Documentation: https://www.zuora.com/developer/api-reference/#operation/DELETE_SummaryJournalEntry.
- number
A key field. Template: ShortText.
- status
Template: ShortText.
- journalEntryDate
Template: Date.
- currency
Template: ShortText.
- homeCurrency
Template: ShortText.
- aggregateCurrency
Data type: DT_BOOL
- transactionType
Template: ShortText.
- accountingPeriodName
Template: ShortText.
- timePeriodStart
Template: Date.
- timePeriodEnd
Template: Date.
- transferredToAccounting
Template: ShortText.
- notes
Template: ShortText.
- cf_pk1__c
Template: ShortText.
- cf_pk2__c
Template: ShortText.
- cf_txt1__c
Template: ShortText.
- cf_txt2__c
Template: ShortText.
- segments
Field components:
- An array.
- Contains the following components: segmentName, segmentValue.
- journalEntryItems
Field components:
- An array.
- Contains the following components: accountingCodeType, accountingCodeName, glAccountName, glAccountNumber, type, amount, homeCurrencyAmount.
Based on resource template Base.
- [Create] action
-
Endpoint URL address:
/object/taxation-item.Documentation: https://www.zuora.com/developer/api-reference/#operation/Object_POSTTaxationItem.
- [Update] action
-
Endpoint URL address:
/object/taxation-item/{{=item.id}}.Documentation: https://www.zuora.com/developer/api-reference/#operation/Object_PUTTaxationItem.
- [Delete] action
-
Endpoint URL address:
/object/taxation-item/{{=item.id}}.Documentation: https://www.zuora.com/developer/api-reference/#operation/Object_DELETETaxationItem.
- id
A key field. Template: ShortText.
- accountingCode
Template: ShortText.
- exemptAmount
Data type: DT_R8
- invoiceItemId
Template: ShortText.
- jurisdiction
Template: ShortText.
- locationCode
Template: ShortText.
- name
Template: ShortText.
- taxAmount
Data type: DT_R8
- taxCode
Template: ShortText.
- taxCodeDescription
Template: ShortText.
- taxDate
Template: Date.
- taxMode
Template: ShortText.
- taxRate
Data type: DT_R8
- taxRateDescription
Template: ShortText.
- taxRateType
Template: ShortText.
Based on resource template Base.
- [Create] action
-
Endpoint URL address:
/object/unit-of-measure.Documentation: https://www.zuora.com/developer/api-reference/#operation/Object_POSTUnitOfMeasure.
- [Update] action
-
Endpoint URL address:
/object/unit-of-measure/{{=item.id}}.Documentation: https://www.zuora.com/developer/api-reference/#operation/Object_PUTUnitOfMeasure.
- [Delete] action
-
Endpoint URL address:
/object/unit-of-measure/{{=item.id}}.Documentation: https://www.zuora.com/developer/api-reference/#operation/Object_DELETEUnitOfMeasure.
- id
A key field. Template: ShortText.
- active
Data type: DT_BOOL
- decimalPlaces
Data type: DT_I4
- displayedAs
Template: ShortText.
- roundingMode
Template: ShortText.
- uomName
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/usage/accounts/{{=parametedr.accountKey}}.
The result is extracted from:{{=response.usage}}.The action has the following user-defined parameters:
- accountKey: Required. Specify account identifier.
Documentation: https://www.zuora.com/developer/api-reference/#operation/GET_Usage.
- [Create] action
-
Endpoint URL address:
/object/usage.Documentation: https://www.zuora.com/developer/api-reference/#operation/Object_POSTUsage.
- [Update] action
-
Endpoint URL address:
/object/usage/{{=item.id}}.Documentation: https://www.zuora.com/developer/api-reference/#operation/Object_PUTUsage.
- [Delete] action
-
Endpoint URL address:
/object/usage/{{=item.id}}.Documentation: https://www.zuora.com/developer/api-reference/#operation/Object_DELETEUsage.
- id
A key field. Template: ShortText.
- chargeId
Template: ShortText.
- chargeNumber
Template: ShortText.
- sourceName
Template: ShortText.
- quantity
Data type: DT_R8
- unitOfMeasure
Template: ShortText.
- accountName
Template: ShortText.
- subscriptionId
Template: ShortText.
- subscriptionNumber
Template: ShortText.
- startDateTime
Template: DateTime.
- accountNumber
Template: ShortText.
- status
Template: ShortText.
- submissionDateTime
Template: DateTime.
- accountId
Template: ShortText.
- endDateTime
Template: DateTime.
- description
Template: ShortText.
- uom
Template: ShortText.
- [Read] action
-
Endpoint URL address:
{{=_.isEmpty(parameters.iterator) ? '/action/query' : '/action/queryMore'}}.
The result is extracted from:{{=response.records}}.
The action uses POST method.
The result is paginated.The action has the following user-defined parameters:
- query: Specify ZOQL statement.
The following request parameters will be automatically processed:
-
application/json:
{{=_.isEmpty(parameters.iterator) ? { queryString: parameters.query, batchSize: parameters.batchSize } : { queryLocator: parameters.iterator } }}
- [External]
-
The external fields list is extracted from:
{{=Zuora.getStatementFields(parameters.query)}}.- {{=external.name}}
Template: {{=external.template}}.
- [Read] action
-
The result is paginated.The following request parameters will be automatically processed:
-
page:
{{=parameters.iterator}} -
pageSize:
{{=parameters.batchSize}} -
_includeUserParameters:
{{=parameters}}
-
page:
- [Create] action
-
The action uses POST method.The following request parameters will be automatically processed:
-
application/json:
{{=item}}
-
application/json:
- [Update] action
-
The action uses PUT method.The following request parameters will be automatically processed:
-
application/json:
{{=item}}
-
application/json:
- [Delete] action
-
The action uses DELETE method.
- ShortText
Data type: DT_WSTR ( length 255 )
- LongText
Data type: DT_WSTR ( length 1000 )
- DateTime
Data type: DT_DBTIMESTAMP
- Date
Data type: DT_DBDATE
- Number
Data type: DT_R8
- FinanceInformationT
Field components:
-
Uses template:
ShortText. - Contains the following components: recognizedRevenueAccountingCode, recognizedRevenueAccountingCodeType, deferredRevenueAccountingCode, deferredRevenueAccountingCodeType.
-
Uses template:
- ProductRatePlan
Field components:
-
Uses template:
ShortText. - Contains the following components: id, status, name, description, effectiveStartDate, effectiveEndDate, productRatePlanCharges.
-
Uses template:
- Contact
Field components:
-
Uses template:
ShortText. - Contains the following components: address1, address2, city, country, county, fax, firstName, homePhone, lastName, mobilePhone, nickname, otherPhone, otherPhoneType, personalEmail, state, taxRegion, workEmail, workPhone, zipCode.
-
Uses template:
- PaymentFinanceInformation
Field components:
-
Uses template:
ShortText. - Contains the following components: bankAccountAccountingCode, bankAccountAccountingCodeType, unappliedPaymentAccountingCode, unappliedPaymentAccountingCodeType, transferredToAccounting.
-
Uses template:
- SubscriptionT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, accountId, accountNumber, accountName, invoiceOwnerAccountId, invoiceOwnerAccountNumber, invoiceOwnerAccountName, subscriptionNumber, termType, invoiceSeparately, contractEffectiveDate, serviceActivationDate, customerAcceptanceDate, subscriptionStartDate, termStartDate, termEndDate, initialTerm, initialTermPeriodType, currentTerm, currentTermPeriodType, autoRenew, renewalSetting, renewalTerm, renewalTermPeriodType, contractedMrr, totalContractedValue, notes, status, QuoteNumber__QT, QuoteBusinessType__QT, OpportunityCloseDate__QT, OpportunityName__QT, CpqBundleJsonId__QT, QuoteType__QT, collect, runBilling, targetDate, customField__c, subscribeToRatePlans.
-
Uses template:
What's New
- New: Support for asynchronous Data Query.
- New: Support for ZOQL statements.
- Fixed: Unable to retrieve data from account resource (Thank you, Angel).
- New: Introduced connection.
Related documentation
COZYROC SSIS+ Components Suite is free for testing in your development environment.
A licensed version can be deployed on-premises, on Azure-SSIS IR and on COZYROC Cloud.