{
"opencollection": "1.0.0",
"info": {
"name": "API Reference Accounting Codes Invoices API",
"version": "2023-12-15"
},
"items": [
{
"info": {
"name": "Invoices",
"type": "folder"
},
"items": [
{
"info": {
"name": "Create standalone invoices",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/v1/invoices/batch",
"headers": [
{
"name": "Idempotency-Key",
"value": ""
},
{
"name": "Accept-Encoding",
"value": ""
},
{
"name": "Content-Encoding",
"value": ""
},
{
"name": "Authorization",
"value": ""
},
{
"name": "Zuora-Track-Id",
"value": ""
},
{
"name": "Zuora-Entity-Ids",
"value": ""
},
{
"name": "Zuora-Org-Ids",
"value": ""
}
]
},
"docs": "Creates multiple standalone invoices for selling physical goods, services or other items on a non-recurring basis to your subscription customers.\n\nTo use this operation, you must have the \"Create Standalone Invoice\" and \"Modify Invoice\" user permissions. See [Billing Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles) for more information. As of Zuora Release 2022.03.R5, newly created standard Billing users have the “Create St"
},
{
"info": {
"name": "Create a standalone invoice",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/v1/invoices",
"headers": [
{
"name": "Idempotency-Key",
"value": ""
},
{
"name": "Accept-Encoding",
"value": ""
},
{
"name": "Content-Encoding",
"value": ""
},
{
"name": "Authorization",
"value": ""
},
{
"name": "Zuora-Track-Id",
"value": ""
},
{
"name": "Zuora-Entity-Ids",
"value": ""
},
{
"name": "Zuora-Org-Ids",
"value": ""
}
]
},
"docs": "Creates a standalone invoice for selling physical goods, services or other items on a non-recurring basis to your subscription customers.\n\nTo use this operation, you must have the \"Create Standalone Invoice\" and \"Modify Invoice\" user permissions. See [Billing Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles) for more information. As of Zuora Release 2022.03.R5, newly created standard Billing users have the “Create Standalone"
},
{
"info": {
"name": "Update invoices",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/v1/invoices",
"headers": [
{
"name": "Accept-Encoding",
"value": ""
},
{
"name": "Content-Encoding",
"value": ""
},
{
"name": "Authorization",
"value": ""
},
{
"name": "Zuora-Track-Id",
"value": ""
},
{
"name": "Zuora-Entity-Ids",
"value": ""
},
{
"name": "Zuora-Org-Ids",
"value": ""
}
]
},
"docs": "Updates multiple invoices in batches with one call. \n\n### Limitations \nThis operation has the following limitations:\n* You can update a maximum of 50 invoices by one call.\n"
},
{
"info": {
"name": "Post invoices",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/v1/invoices/bulk-post",
"headers": [
{
"name": "Idempotency-Key",
"value": ""
},
{
"name": "Accept-Encoding",
"value": ""
},
{
"name": "Content-Encoding",
"value": ""
},
{
"name": "Authorization",
"value": ""
},
{
"name": "Zuora-Track-Id",
"value": ""
},
{
"name": "Zuora-Entity-Ids",
"value": ""
},
{
"name": "Zuora-Org-Ids",
"value": ""
}
]
},
"docs": "Posts multiple invoices.\n\nYou can post a maximum of 50 invoices in one single request. Additionally, you can also update invoice dates while posting the invoices.\n"
},
{
"info": {
"name": "Retrieve an invoice",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/v1/invoices/:invoiceKey",
"headers": [
{
"name": "Accept-Encoding",
"value": ""
},
{
"name": "Content-Encoding",
"value": ""
},
{
"name": "Authorization",
"value": ""
},
{
"name": "Zuora-Track-Id",
"value": ""
},
{
"name": "Zuora-Entity-Ids",
"value": ""
},
{
"name": "Zuora-Org-Ids",
"value": ""
}
],
"params": [
{
"name": "invoiceKey",
"value": "",
"type": "path",
"description": "The ID or number of the invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-0000001.\n"
}
]
},
"docs": "Retrieves a specific invoice.\n"
},
{
"info": {
"name": "Update an invoice",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/v1/invoices/:invoiceKey",
"headers": [
{
"name": "Accept-Encoding",
"value": ""
},
{
"name": "Content-Encoding",
"value": ""
},
{
"name": "Authorization",
"value": ""
},
{
"name": "Zuora-Track-Id",
"value": ""
},
{
"name": "Zuora-Entity-Ids",
"value": ""
},
{
"name": "Zuora-Org-Ids",
"value": ""
}
],
"params": [
{
"name": "invoiceKey",
"value": "",
"type": "path",
"description": "The ID or number of the invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-0000001.\n"
}
]
},
"docs": "Updates a specific invoice. \n"
},
{
"info": {
"name": "Delete an invoice",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/v1/invoices/:invoiceKey",
"headers": [
{
"name": "Accept-Encoding",
"value": ""
},
{
"name": "Content-Encoding",
"value": ""
},
{
"name": "Authorization",
"value": ""
},
{
"name": "Zuora-Track-Id",
"value": ""
},
{
"name": "Zuora-Entity-Ids",
"value": ""
},
{
"name": "Zuora-Org-Ids",
"value": ""
}
],
"params": [
{
"name": "invoiceKey",
"value": "",
"type": "path",
"description": "The ID or number of the invoice to be deleted. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-0000001.\n"
}
]
},
"docs": "Deletes a specific invoice.\n\nWhether to delete an invoice synchronously or asynchronously depends on the number of invoice items contained in the invoice. By default, if an invoice contains less than 100 items, the invoice is deleted synchronously. Otherwise, the invoice is deleted asynchronously. If you want to change the threshold, submit a request at Zuora Global Support.\n"
},
{
"info": {
"name": "List all application parts of an invoice",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/v1/invoices/:invoiceKey/application-parts",
"headers": [
{
"name": "Accept-Encoding",
"value": ""
},
{
"name": "Content-Encoding",
"value": ""
},
{
"name": "Authorization",
"value": ""
},
{
"name": "Zuora-Track-Id",
"value": ""
},
{
"name": "Zuora-Entity-Ids",
"value": ""
},
{
"name": "Zuora-Org-Ids",
"value": ""
}
],
"params": [
{
"name": "invoiceKey",
"value": "",
"type": "path",
"description": "The ID or number of the invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-0000001.\n"
}
]
},
"docs": "**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billin"
},
{
"info": {
"name": "Email an invoice",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/v1/invoices/:invoiceKey/emails",
"headers": [
{
"name": "Idempotency-Key",
"value": ""
},
{
"name": "Accept-Encoding",
"value": ""
},
{
"name": "Content-Encoding",
"value": ""
},
{
"name": "Authorization",
"value": ""
},
{
"name": "Zuora-Track-Id",
"value": ""
},
{
"name": "Zuora-Entity-Ids",
"value": ""
},
{
"name": "Zuora-Org-Ids",
"value": ""
}
],
"params": [
{
"name": "invoiceKey",
"value": "",
"type": "path",
"description": "The ID or number of the invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-0000001.\n"
}
]
},
"docs": "Sends a posted invoice to the specified email addresses manually.\n### Notes\n - You must activate the **Manual Email For Invoice | Manual Email For Invoice** notification before emailing invoices. To include the invoice PDF in the email, select the **Include Invoice PDF** check box in the **Edit notification** dialog from the Zuora UI. See [Create and Edit Notifications](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/Notifications/C_Create_Notifications#section_2) for more informa"
},
{
"info": {
"name": "List all files of an invoice",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/v1/invoices/:invoiceKey/files",
"headers": [
{
"name": "Accept-Encoding",
"value": ""
},
{
"name": "Content-Encoding",
"value": ""
},
{
"name": "Authorization",
"value": ""
},
{
"name": "Zuora-Track-Id",
"value": ""
},
{
"name": "Zuora-Entity-Ids",
"value": ""
},
{
"name": "Zuora-Org-Ids",
"value": ""
}
],
"params": [
{
"name": "pageSize",
"value": "",
"type": "query",
"description": "The number of records returned per page in the response.\n"
},
{
"name": "page",
"value": "",
"type": "query",
"description": "The index number of the page that you want to retrieve. This parameter is dependent on `pageSize`. You must set `pageSize` before specifying `page`. For example, if you set `pageSize` to `20` and `page` to `2`, the 21st to 40th records are returned in the response.\n"
},
{
"name": "invoiceKey",
"value": "",
"type": "path",
"description": "The unique ID or number of an invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV00000001.\n"
}
]
},
"docs": "Retrieves the information about all PDF files of a specified invoice. \n\nInvoice PDF files are returned in reverse chronological order by the value of the `versionNumber` field.\n**Note**: This API only retrieves the PDF files that have been generated. If the latest PDF file is being generated, it will not be included in the response.\nYou can use the [Query](/api-references/api/operation/Action_POSTquery) action to get the latest PDF file, for example: `\"select Body from Invoice where Id = '2c9380"
},
{
"info": {
"name": "Upload a file for an invoice",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/v1/invoices/:invoiceKey/files",
"headers": [
{
"name": "Idempotency-Key",
"value": ""
},
{
"name": "Accept-Encoding",
"value": ""
},
{
"name": "Content-Encoding",
"value": ""
},
{
"name": "Authorization",
"value": ""
},
{
"name": "Zuora-Entity-Ids",
"value": ""
},
{
"name": "Zuora-Org-Ids",
"value": ""
},
{
"name": "Zuora-Track-Id",
"value": ""
}
],
"params": [
{
"name": "invoiceKey",
"value": "",
"type": "path",
"description": "The ID or number of the invoice that you want to upload a PDF file for. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV00000001.\n"
}
]
},
"docs": "Uploads an externally generated invoice PDF file for an invoice that is in Draft or Posted status.\nTo use this operation, you must enable the Modify Invoice permission. See [Billing Permissions](https://knowledgecenter.zuora.com/Billing/Tenant_Management/A_Administrator_Settings/User_Roles/d_Billing_Roles) for more information.\nThis operation has the following restrictions:\n- Only the PDF file format is supported.\n- The maximum size of the PDF file to upload is 4 MB.\n- A maximum of 50 PDF files "
},
{
"info": {
"name": "List all items of an invoice",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/v1/invoices/:invoiceKey/items",
"headers": [
{
"name": "Accept-Encoding",
"value": ""
},
{
"name": "Content-Encoding",
"value": ""
},
{
"name": "Authorization",
"value": ""
},
{
"name": "Zuora-Track-Id",
"value": ""
},
{
"name": "Zuora-Entity-Ids",
"value": ""
},
{
"name": "Zuora-Org-Ids",
"value": ""
}
],
"params": [
{
"name": "pageSize",
"value": "",
"type": "query",
"description": "The number of records returned per page in the response.\n"
},
{
"name": "page",
"value": "",
"type": "query",
"description": "The index number of the page that you want to retrieve. This parameter is dependent on `pageSize`. You must set `pageSize` before specifying `page`. For example, if you set `pageSize` to `20` and `page` to `2`, the 21st to 40th records are returned in the response.\n"
},
{
"name": "invoiceKey",
"value": "",
"type": "path",
"description": "The unique ID or number of an invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV00000001.\n"
}
]
},
"docs": "Retrieves the information about all items of a specified invoice. \n"
},
{
"info": {
"name": "List all taxation items of an invoice item",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/v1/invoices/:invoiceKey/items/:itemId/taxation-items",
"headers": [
{
"name": "Accept-Encoding",
"value": ""
},
{
"name": "Content-Encoding",
"value": ""
},
{
"name": "Authorization",
"value": ""
},
{
"name": "Zuora-Track-Id",
"value": ""
},
{
"name": "Zuora-Entity-Ids",
"value": ""
},
{
"name": "Zuora-Org-Ids",
"value": ""
}
],
"params": [
{
"name": "pageSize",
"value": "",
"type": "query",
"description": "The number of records returned per page in the response.\n"
},
{
"name": "page",
"value": "",
"type": "query",
"description": "The index number of the page that you want to retrieve. This parameter is dependent on `pageSize`. You must set `pageSize` before specifying `page`. For example, if you set `pageSize` to `20` and `page` to `2`, the 21st to 40th records are returned in the response.\n"
},
{
"name": "invoiceKey",
"value": "",
"type": "path",
"description": "The unique ID or number of an invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV00000001.\n"
},
{
"name": "itemId",
"value": "",
"type": "path",
"description": "The unique ID of an invoice item. For example, 2c86c8955bd63cc1015bd7c151af02ef.\n"
}
]
},
"docs": "Retrieves information about the taxation items of a specific invoice item. \n"
},
{
"info": {
"name": "Reverse an invoice",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/v1/invoices/:invoiceKey/reverse",
"headers": [
{
"name": "Accept-Encoding",
"value": ""
},
{
"name": "Content-Encoding",
"value": ""
},
{
"name": "Authorization",
"value": ""
},
{
"name": "Zuora-Track-Id",
"value": ""
},
{
"name": "Zuora-Entity-Ids",
"value": ""
},
{
"name": "Zuora-Org-Ids",
"value": ""
}
],
"params": [
{
"name": "invoiceKey",
"value": "",
"type": "path",
"description": "The ID or number of the invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-0000001.\n"
}
]
},
"docs": "**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billin"
},
{
"info": {
"name": "Write off an invoice",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/v1/invoices/:invoiceKey/write-off",
"headers": [
{
"name": "Accept-Encoding",
"value": ""
},
{
"name": "Content-Encoding",
"value": ""
},
{
"name": "Authorization",
"value": ""
},
{
"name": "Zuora-Track-Id",
"value": ""
},
{
"name": "Zuora-Entity-Ids",
"value": ""
},
{
"name": "Zuora-Org-Ids",
"value": ""
}
],
"params": [
{
"name": "invoiceKey",
"value": "",
"type": "path",
"description": "The ID or number of the invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-0000001.\n"
}
]
},
"docs": "**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billin"
},
{
"info": {
"name": "Create taxation items for an invoice",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/v1/invoices/:invoiceKey/taxationitems",
"headers": [
{
"name": "Idempotency-Key",
"value": ""
},
{
"name": "Accept-Encoding",
"value": ""
},
{
"name": "Content-Encoding",
"value": ""
},
{
"name": "Authorization",
"value": ""
},
{
"name": "Zuora-Track-Id",
"value": ""
},
{
"name": "Zuora-Entity-Ids",
"value": ""
},
{
"name": "Zuora-Org-Ids",
"value": ""
}
],
"params": [
{
"name": "invoiceKey",
"value": "",
"type": "path",
"description": "The unique ID or number of an invoice. For example, 8a8082e65b27f6c3015ba45ff82c7172 or INV00000001.\n"
}
]
},
"docs": "Creates taxation items for an invoice.\n"
},
{
"info": {
"name": "Generate an e-invoice file for an invoice",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/v1/invoices/:invoiceKey/einvoice/generate",
"headers": [
{
"name": "Accept-Encoding",
"value": ""
},
{
"name": "Content-Encoding",
"value": ""
},
{
"name": "Authorization",
"value": ""
},
{
"name": "Zuora-Track-Id",
"value": ""
},
{
"name": "Zuora-Entity-Ids",
"value": ""
},
{
"name": "Zuora-Org-Ids",
"value": ""
}
],
"params": [
{
"name": "invoiceKey",
"value": "",
"type": "path",
"description": "The ID or number of the invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-0000001.\n"
}
]
},
"docs": "Generates an e-invoice file for an invoice.\n\n**Note**: This operation is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled.\n"
}
]
}
],
"bundled": true
}