Skip to content

Latest commit

 

History

History
34 lines (31 loc) · 5.91 KB

ProxyGetInvoiceItemAdjustment.md

File metadata and controls

34 lines (31 loc) · 5.91 KB
Raw

Zuora::ProxyGetInvoiceItemAdjustment

Properties

Name Type Description Notes
account_id String The ID of the account that owns the invoice. Values: inherited from `Account.ID` for the invoice owner [optional]
accounting_code String The accounting code for the invoice item. Accounting codes group transactions that contain similar accounting attributes. Character limit: 100 Values: inherited from `InvoiceItem.AccountingCode` [optional]
adjustment_date Date The date when the invoice item adjustment is applied, in `yyyy-mm-dd` format. This date must be the same as the invoice's date or later. Character limit: 29 [optional]
adjustment_number String A unique string to identify an individual invoice item adjustment. Character limit: 255 Values: automatically generated [optional]
amount Float The amount of the invoice item adjustment. The value of Amount must be positive. Use the required parameter Type to either credit or charge (debit) this amount on the invoice. Character limit: 16 Values: a valid currency amount [optional]
cancelled_by_id String The ID of the Zuora user who canceled the invoice item adjustment. Zuora generates this read-only field only if the adjustment is canceled. Character limit: 32 Values: automatically generated [optional]
cancelled_date DateTime The date when the invoice item adjustment is canceled. Zuora generates this read-only field if this adjustment is canceled. Character limit: 29 Values: automatically generated [optional]
comment String Use this field to record comments about the invoice item adjustment. Character limit: 255 Values: a string of 255 characters or fewer [optional]
created_by_id String The user ID of the person who created the invoice item. Character limit: 32 Values: automatically generated [optional]
created_date DateTime The date the invoice item was created. Character limit: 29 Values: automatically generated [optional]
customer_name String 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 `InvoiceItemAdjustment` do not change when `Account.Name` is updated. [optional]
customer_number String The unique account number of the customer's account. Character limit: 50 Values: inherited from `Account.AccountNumber` Note: This value changes if `Account.AccountNumber` is updated. The values of `UpdatedById` and `UpdatedDate` for the `InvoiceItemAdjustment` do not change when `Account.AccountNumber` is updated. [optional]
id String Object identifier. [optional]
invoice_id String The ID of the invoice associated with the adjustment. The adjustment invoice item is in this invoice. This field is optional if you specify a value for the `InvoiceNumber` field. Character limit: 3 Values: a valid invoice ID [optional]
invoice_item_name String The name of the invoice item's charge. This field is required in the Query call, but is inherited in other calls. Character limit: 255 Values: inherited from `InvoiceItem.ChargeName` [optional]
invoice_number String The unique identification number for the invoice that contains the invoice item. This field is optional if you specify a value for the `InvoiceId` field. Character limit: 32 Values: a valid invoice number [optional]
reason_code String 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 [optional]
reference_id String 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 [optional]
service_end_date Date The end date of the service period associated with the invoice item. Service ends one second before the date in this value. Character limit: 29 [optional]
service_start_date Date The start date of the service period associated with the invoice item. Service ends one second before the date in this value. Character limit: 29 [optional]
source_id String The ID of the item specified in the SourceType field. Character limit: 32 Values: a valid invoice item ID or taxation item ID [optional]
source_type String The type of adjustment. Character limit: 13 Values: InvoiceDetail, Tax [optional]
status String The status of the invoice item adjustment. This field is required in the Query call, but is automatically generated in other calls. Character limit: 9 Values: Canceled, Processed [optional]
transferred_to_accounting String Indicates the status of the adjustment's transfer to an external accounting system, such as NetSuite. Character limit: 10 Values: Processing, Yes, Error, Ignore [optional]
type String Query Filter [optional]
updated_by_id String The ID of the user who last updated the invoice item. Character limit: 32 Values: automatically generated [optional]
updated_date DateTime The date when the invoice item was last updated. Character limit: 29 Values: automatically generated [optional]