# CRUD: Retrieve an invoice

Endpoint: GET /v1/object/invoice/{id}
Version: 2025-12-17

## Header parameters:

  - `Accept-Encoding` (string)
    Include the Accept-Encoding: gzip header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. 

If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a Content-Encoding header with the compression algorithm so that your client can decompress it.

  - `Content-Encoding` (string)
    Include the Content-Encoding: gzip header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.

  - `Authorization` (string)
    The value is in the Bearer {token} format where {token} is a valid OAuth token generated by calling Create an OAuth token.

  - `Zuora-Entity-Ids` (string)
    An entity ID. If you have Zuora Multi-entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.

  - `Zuora-Track-Id` (string)
    A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue.

The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

  - `X-Zuora-WSDL-Version` (string)
    Zuora WSDL version number.

## Query parameters:

  - `fields` (string)
    Object fields to return

## Path parameters:

  - `id` (string, required)
    Object id

## Response 200 fields (application/json):

  - `Id` (string)
    Object identifier.

  - `AccountId` (string)

  - `AdjustmentAmount` (number)
    The amount of the invoice adjustments associated with the invoice.  Character limit: 16 Values: a valid currency amount

  - `Amount` (number)
    The sum of all charges and taxes associated with the invoice.
Character limit: 16 Values: automatically generated

  - `AmountWithoutTax` (number)
    The sum of all charges associated with the invoice. Taxes are excluded from this value.
Character limit: 16 Values: automatically generated

  - `Balance` (number)
    The remaining balance of the invoice after all payments, adjustments, and refunds are applied.
Character limit: 16 Values: automatically generated

  - `BillToContactId` (string)
    The ID of bill-to contact associated with the invoice. 

Note: This field is available only if you set the X-Zuora-WSDL-Version request header to 118 or later. The value of this field is null if you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled.

  - `Body` (string)
    Required

  - `Comments` (string)
    Additional information related to the invoice that a Zuora user added to the invoice.
Character limit: 255 Values: a string of 255 characters or fewer

  - `CreatedById` (string)
    The user ID of the person who created the invoice. If a bill run generated the invoice, then the value is the user ID of person who created the bill run.
Character limit: 32 Values: automatically generated

  - `CreatedDate` (string)
    The date when the invoice was generated.
Character limit: 29 Values: automatically generated

  - `CreditBalanceAdjustmentAmount` (number)
    The currency amount of the adjustment applied to the customer's credit balance.
Character limit: 16 Values: a valid currency amount This field is only available if the [Zuora Global Support](http://support.zuora.com/) to enable this feature.

  - `CreditMemoAmount` (number)
    The currency amount of all credit memos applied to this invoice.

Note: This field 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/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.

  - `DueDate` (string)
    The date by which the payment for this invoice is due.
Character limit: 29 Version notes: --

  - `IncludesOneTime` (boolean)
    Whether the bill run picks up all one-time charges for processing. You can use this field only with the Generate call for the Invoice object.

  - `IncludesRecurring` (boolean)
    Whether the bill run picks up all recurring charges for processing. You can use this field only with the Generate call for the Invoice object.

  - `IncludesUsage` (boolean)
    Whether the bill run picks up all usage charges for processing. You can use this field only with the Generate call for the Invoice object.

  - `InvoiceDate` (string)
    Specifies the date on which to generate the invoice.
Character limit: 29 Version notes: --

  - `InvoiceNumber` (string)
    The unique identification number for the invoice. This number is returned as a string.
Character limit: 32 Values: automatically generated

  - `LastEmailSentDate` (string)
    The date when the invoice was last emailed.
Character limit: 29 Values: automatically generated

  - `PaymentAmount` (number)
    The amount of payments applied to the invoice.
Character limit: 16 Values: automatically generated

  - `PaymentTerm` (string)
    The name of payment term associated with the invoice.

Note: 
- This field is available only if you set the X-Zuora-WSDL-Version request header to 118 or later. 
- If you have the Flexible Billing Attributes feature disabled, this field is unavailable in the request body and the value of this field is null in the response body. 
- If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select Default Term from Account for this field during subscription creation, the value of this field is automatically set to null in the response body.

  - `PostedBy` (string)
    The user ID of the person who moved the invoice to Posted status.
Character limit: 32 Values: automatically generated

  - `PostedDate` (string)
    The date when the invoice was posted.
Character limit: 29 Values: automatically generated

  - `RefundAmount` (number)
    Specifies the amount of a refund that was applied against an earlier payment on the invoice.
Character limit: 16 Values: automatically generated

  - `SequenceSetId` (string)
    The ID of the sequence set associated with the invoice.

Note: This field is available only if you set the X-Zuora-WSDL-Version request header to 127 or later. The value of this field is null if you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled.

  - `Status` (string)
    The status of the invoice in the system. This status is not the status of the payment of the invoice, just the status of the invoice itself.
Character limit: 8 Values: one of the following:

-  Draft (default, automatically set upon invoice creation)

-  Posted

-  Canceled

  - `SourceType` (string)
    The type of the invoice source. Note: To use this field, you must set the X-Zuora-WSDL-Version request header to 118 or later. Otherwise, an error occurs. Character limit: 16 Values: one of the following enum values:

-  Subscription

-  Standalone

-  Order

-  Consolidation

  - `TargetDate` (string)
    This date is used to determine which charges are to be billed. All charges that are to be billed on this date or prior will be included in this bill run.
Character limit: 29 Version notes: --

  - `TaxAmount` (number)
    The total amount of the taxes applied to the invoice.
Character limit: 16 Values: automatically generated

  - `TaxExemptAmount` (number)
    The total amount of the invoice that is exempt from taxation.
Character limit: 16 Values: automatically generated

  - `TransferredToAccounting` (string)
    Specifies whether or not the invoice was transferred to an external accounting system, such as NetSuite.
Character limit: 10 Values: Processing, Yes, Error, Ignore

  - `UpdatedById` (string)

  - `UpdatedDate` (string)
    The date when the invoice was last updated.
Character limit: 29 Values: automatically generated

  - `IntegrationId__NS` (string)
    ID of the corresponding object in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).

  - `IntegrationStatus__NS` (string)
    Status of the invoice's synchronization with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).

  - `SyncDate__NS` (string)
    Date when the invoice was synchronized with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).

## Response 401 fields (application/json):

  - `message` (string)
    Error message.

If the error message is "Authentication error", ensure that the Authorization request header contains valid authentication credentials, then retry the request. See [Authentication](https://developer.zuora.com/rest-api/general-concepts/authentication/) for more information.

If the error message is "Failed to get user info", retry the request.

## Response 404 fields (application/json):

  - `done` (boolean)

  - `records` (array)

  - `size` (integer)