Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Zuora

Zuora Invoices API

Invoices provides information about customers' accounts for invoices, for examples, dates, status, and amounts. For more information about invoices, see Invoice.

Documentation Provider Profile APIs.io OpenAPI GitHub

Zuora Invoices API is one of 80 APIs that Zuora publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Invoices. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 17 operations across 13 paths, and defines 52 schemas. It is described by OpenAPI 2.0, at version 2023-12-15.

17 operations 13 paths 52 schemas 1 DELETE5 GET6 POST5 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
2023-12-15
Contact
docs@zuora.com
Resource Areas
1

Paths & Operations 17

Across 13 paths, the API surfaces 17 operations — 1 DELETE, 5 GET, 6 POST, 5 PUT. Each is listed below with its method, path, parameters, and response codes.

Invoices 17

Invoices provides information about customers' accounts for invoices, for examples, dates, status, and amounts. For more information about invoices, see Invoice .

POST
/v1/invoices/batch
Create standalone invoices
POST_StandaloneInvoices 8 params → 200
POST
/v1/invoices
Create a standalone invoice
POST_StandaloneInvoice 8 params → 200
PUT
/v1/invoices
Update invoices
PUT_BatchUpdateInvoices 7 params → 200
POST
/v1/invoices/bulk-post
Post invoices
POST_PostInvoices 8 params → 200
PUT
/v1/invoices/{invoiceKey}
Update an invoice
PUT_UpdateInvoice 8 params → 200
DELETE
/v1/invoices/{invoiceKey}
Delete an invoice
DELETE_DeleteInvoice 7 params → 200
GET
/v1/invoices/{invoiceKey}
Retrieve an invoice
Get_GetInvoice 7 params → 200
GET
/v1/invoices/{invoiceKey}/application-parts
List all application parts of an invoice
GET_InvoiceApplicationParts 7 params → 200
POST
/v1/invoices/{invoiceKey}/emails
Email an invoice
POST_EmailInvoice 9 params → 200
POST
/v1/invoices/{invoiceKey}/files
Upload a file for an invoice
POST_UploadFileForInvoice 9 params → 200
GET
/v1/invoices/{invoiceKey}/files
List all files of an invoice
GET_InvoiceFiles 9 params → 200
GET
/v1/invoices/{invoiceKey}/items
List all items of an invoice
GET_InvoiceItems 9 params → 200
GET
/v1/invoices/{invoiceKey}/items/{itemId}/taxation-items
List all taxation items of an invoice item
GET_TaxationItemsOfInvoiceItem 10 params → 200
PUT
/v1/invoices/{invoiceKey}/reverse
Reverse an invoice
PUT_ReverseInvoice 8 params → 200
PUT
/v1/invoices/{invoiceKey}/write-off
Write off an invoice
PUT_WriteOffInvoice 8 params → 200
POST
/v1/invoices/{invoiceKey}/taxationitems
Create taxation items for an invoice
POST_INV_TaxationItems 9 params → 200
PUT
/v1/invoices/{invoiceKey}/einvoice/generate
Generate an e-invoice file for an invoice
PUT_GenerationEInvoiceGenerationForInvoices 7 params → 200

Schemas 52

The contract defines 52 schemas that model the data the API accepts and returns. The most detailed are GetInvoiceApplicationPartType (7 properties), DeleteInvoiceResponseType (5 properties), CreditMemoObjectNSFields (5 properties), InvoiceFile (3 properties). Each schema is shown below with its type and property counts.

PutInvoiceResponseType
ContactCustomFields
object
PutReverseInvoiceResponseType
object
3 properties
InvoiceItem
InvoicePostType
PutInvoiceItemType
PUTWriteOffInvoiceRequest
object
CommonResponseType
object
3 properties
InvoiceObjectNSFields
object
Container for Invoice fields provided by the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).
3 properties
POSTUploadFileResponse
object
2 properties
CreditMemoObjectCustomFields
object
Container for custom fields of a Credit Memo object.
GETInvoiceFilesResponse
object
3 properties
PutInvoiceType
CreditMemoItemObjectCustomFields
object
Container for custom fields of a Credit Memo Item object.
PostBatchInvoiceItemResponse
DiscountItemObjectNSFields
object
Container for discount Item fields provided by the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).
3 properties
PostDiscountItemType
InvoicePostResponseType
PostInvoiceType
DiscountItemObjectCustomFields
object
Container for custom fields of an Discount Item object.
GETInvoiceTaxationItemsResponse
object
3 properties
InvoicesBatchPostResponseType
PostInvoiceResponse
PutBatchInvoiceType
object
1 property
PutDiscountItemType
InvoiceItemObjectCustomFields
object
Container for custom fields of an Invoice Item object.
POSTTaxationItemList
object
1 property
InvoiceItemObjectNSFields
object
Container for Invoice Item fields provided by the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).
3 properties
DeleteInvoiceResponseType
object
5 properties
GETTaxationItemListType
object
2 properties
CreditMemoObjectNSFields
object
Container for Credit Memo fields provided by the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).
5 properties
PutReverseInvoiceType
object
2 properties
PUTWriteOffInvoiceResponse
object
2 properties
InvoiceWithCustomRatesType
InvoiceFile
object
3 properties
PostInvoiceItemType
GETTaxationItemTypewithSuccess
GETInvoiceTaxItemType
GetInvoiceApplicationPartCollectionType
object
3 properties
PostBatchInvoiceResponse
object
2 properties
POSTInvoicesBatchPostType
PostInvoiceEmailRequestType
object
3 properties
PostCreateInvoiceContactType
Container for bill-to or sold-to contact information. A new Contact will be created under the invoice owner account. Note: If you have the Flexible Billing Att…
CreditMemoItemFromWriteOffInvoice
InvoiceObjectCustomFields
object
Container for custom fields of an Invoice object.
POSTTaxationItemTypeForInvoice
GETInvoiceItemsResponse
object
3 properties
BatchInvoiceType
GetInvoiceApplicationPartType
object
7 properties
PostBatchInvoicesType
object
2 properties
TaxationItemObjectCustomFields
object
Container for custom fields of a Taxation Item object.
PostTaxationItemType

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zuora-invoices-api-openapi.yml Raw ↑

Other APIs Zuora publishes across the network.

Zuora V1 API
AE Profile APIs.io
Zuora Accounting Codes API
AE Profile APIs.io
Zuora Accounting Periods API
AE Profile APIs.io
Zuora Accounts API
AE Profile APIs.io
Zuora Actions API
AE Profile APIs.io
Zuora Aggregate Queries API
AE Profile APIs.io
Zuora API Health API
AE Profile APIs.io
Zuora Attachments API
AE Profile APIs.io
Zuora Bill Run API
AE Profile APIs.io
Zuora Bill Run Health API
AE Profile APIs.io
Zuora Billing Documents API
AE Profile APIs.io
Zuora Billing Preview Run API
AE Profile APIs.io
#Invoices
← Back to Z APIs
API Details
ID
zuora:zuora-invoices-api
Docs
https://developer.zuora.com/v1-api-reference/introduction
Provider
Zuora
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network