日本語のコンテンツは機械翻訳されており、補助的な参照を目的としています。機械翻訳の精度は保証できません。英語版が正となります。また、現時点では検索機能は日本語での検索をサポートしていません。翻訳に関するフィードバックについては、docs@zuora.comに送信してください。

US Data Center Customers: The SOAP API is no longer under active development. The legacy SOAP calls still function, but are now also available in REST.
EU Data Center Customers: The SOAP API is not available. Please use the REST API.
APAC Data Center Customers: The SOAP API is not available. Please use the REST API.
Going forward, new features will only be available through the REST API. We strongly recommend that all integrations are done using the REST API.
You can find the REST API documentation at https://www.zuora.com/developer/.

generate()

Last updated

Jan 8, 2020
Save as PDF

Use the generate() call to generate an on demand invoice for a specific customer. This process is similar to the process in the Zuora user interface in which you create an ad-hoc bill run for a specific customer account. This SOAP API reference includes syntax, call wrappers and container descriptions, requirements, and examples.

Usage notes

Supported objects: Invoice
Version availability: WSDL 11.0+
Asynchronous process: yes

The id of the generated invoice is returned in the response. If multiple invoices are generated, only the id of the first invoice generated is returned. This occurs when an account has multiple subscriptions with the invoice subscription separately option enabled.

Fields

The following fields are required for this call:

Examples

This example call generates an invoice with the following characteristics:

Customer account ID: 8a8ae4b122561fc00122562fbc3d0002
Date: July 7, 2016
Include all charge types
Default status is Draft

Request:

01<SOAP-ENV:Envelopexmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"xmlns:ns2="http://object.api.zuora.com/"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ns1="http://api.zuora.com/">
02   <SOAP-ENV:Body>
03   <ns1:generate>
04     <ns1:zObjects xsi:type="ns2:Invoice">
05       <ns2:AccountId>8a8ae4b122561fc00122562fbc3d0002</ns2:AccountId>
06       <ns2:IncludesOneTime>True</ns2:IncludesOneTime>
07       <ns2:IncludesRecurring>True</ns2:IncludesRecurring>
08       <ns2:IncludesUsage>True</ns2:IncludesUsage>
09       <ns2:InvoiceDate>2016-07-07</ns2:InvoiceDate>
10       <ns2:TargetDate>2016-07-07</ns2:TargetDate>
11     </ns1:zObjects>
12   </ns1:generate>
13   </SOAP-ENV:Body>
14</SOAP-ENV:Envelope>

Response:

01<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
02   <soapenv:Body>
03      <ns1:generateResponse xmlns:ns1="http://api.zuora.com/">
04         <ns1:result>
05            <ns1:Id>8a8082c453cd2a620153e426c7eb78b3</ns1:Id>
06            <ns1:Success>true</ns1:Success>
07         </ns1:result>
08      </ns1:generateResponse>
09   </soapenv:Body>
10</soapenv:Envelope>