- CRUD: Retrieve an invoice adjustment
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.
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.
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 (').
- https://rest.zuora.comhttps://rest.zuora.com/v1/object/invoice-adjustment/{id}
curl -i -X GET \
'https://rest.zuora.com/v1/object/invoice-adjustment/{id}?fields=string' \
-H 'Accept-Encoding: string' \
-H 'Authorization: string' \
-H 'Content-Encoding: string' \
-H 'Zuora-Entity-Ids: string' \
-H 'Zuora-Track-Id: string'This header is returned if you specify the Accept-Encoding: gzip request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
application/jsonapplication/xmltext/htmltext/csvtext/plain
The request limit quota for the time window closest to exhaustion. See rate limits for more information.
The number of requests remaining in the time window closest to quota exhaustion. See rate limits for more information.
The number of seconds until the quota resets for the time window closest to quota exhaustion. See rate limits for more information.
The Zuora internal identifier of the API call. You cannot control the value of this header.
The ID of the account that owns the invoice. Character limit: 32 Values: inherited from Account.ID for the invoice owner
The date when the invoice adjustment is applied. This date must be the same as the invoice's date or later. Character limit: 29 Values: Leave null to automatically generate the current date
A unique string to identify an individual invoice adjustment. Character limit: 255 Values: automatically generated
The amount of the invoice adjustment. Character limit: 16 Values: a valid currency amount
The ID of the Zuora user who canceled the invoice adjustment. Zuora generates this read-only field only if the adjustment is canceled. Character limit: 32 Values: automatically generated
The date when the invoice adjustment is canceled. Zuora generates this read-only field if this adjustment is canceled. Character limit: 29 Values: automatically generated
Use this field to record comments about the invoice adjustment. Character limit: 255 Values: a string of 255 characters or fewer
The user ID of the person who created the invoice adjustment. Character limit: 32 Values: automatically generated
The date the invoice adjustment was created. Character limit: 29 Values: automatically generated
The name of the account that owns the associated invoice.
Character limit: 50
Values: inherited from Account.Name
Note: This value changes if Account.Name is updated. The values of UpdatedById and UpdatedDate for the InvoiceAdjustment do not change when Account.Name is updated.
The unique account number of the customer's account.
Character limit: 70
Values: inherited from Account.AccountNumber
Note: This value changes if Account.AccountNumber is updated. The values of UpdatedById and UpdatedDate for the InvoiceAdjustment do not change when Account.AccountNumber is updated.
The amount that changes the balance of the associated invoice. Character limit: 16 Values: automatically calculated
The ID of the invoice associated with the adjustment. This field is required if you don't specify a value for the InvoiceNumber field. Character limit: 32 Values: a valid invoice ID
The unique identification number for the associated invoice. This field is required if you don't specify a value for the InvoiceId field. Character limit: 32 Values: a valid invoice number
A code identifying the reason for the transaction. Must be an existing reason code or empty. If you do not specify a value, Zuora uses the default reason code. Character limit: 32 V****alues: a valid reason code
A code to reference an object external to Zuora. For example, you can use this field to reference a case number in an external system. Character limit: 60 Values: a string of 60 characters or fewer
The status of the invoice adjustment. This field is required in the Query call, but is automatically generated in other calls. Character limit: 9 Values: Canceled, Processed
Indicates the status of the adjustment's transfer to an external accounting system, such as NetSuite.
Indicates whether the adjustment credits or debits the invoice amount. Character limit: 6 Values: Credit, Charge
The ID of the user who last updated the invoice. Character limit: 32 Values: automatically generated
The date when the invoice was last updated. Character limit: 29 Values: automatically generated
Custom fields of the Invoice Adjustment object. The name of each custom field has the form customField__c. Custom field names are case sensitive. See Manage Custom Fields for more information.
{ "AdjustmentNumber": "IA-00000001", "CustomerName": "AC_1476935078064", "Id": "2c93808457d787030157e030d3043f79", "AccountingCode": "Accounts Receivable", "ReasonCode": "Standard Adjustment", "AccountId": "2c93808457d787030157e030d0a43f53", "CustomerNumber": "AN_1476935078064", "InvoiceId": "2c93808457d787030157e030d10f3f64", "ImpactAmount": -1.2, "CreatedById": "2c93808457d787030157e030b4fa3dd6", "CreatedDate": "2016-10-20T05:44:38.000+02:00", "Type": "Credit", "Amount": 1.2, "AdjustmentDate": "2016-10-20", "Comments": "this is comments", "UpdatedDate": "2016-10-20T05:44:38.000+02:00", "Status": "Processed", "InvoiceNumber": "INV00000001", "ReferenceId": "refid-1476935078657", "UpdatedById": "2c93808457d787030157e030b4fa3dd6" }