An invoice adjustment modifies an existing invoice. You use an invoice adjustment to change the entire invoice. For example, you can apply a late fee to the invoice balance.
An invoice adjustment differs from an invoice item adjustment. An invoice item adjustment (opens in a new tab) affects an individual charge or line item on an invoice. An invoice adjustment affects the invoice at the header-level.
Both adjustments can affect the invoice balance.
These are the characteristics of an invoice item adjustment:
- Always for a charge in an invoice
- Tied to all accounting and revenue recognition information associated with the charge
- Only one invoice item adjustment to one charge
- Named with prefix, IILA-
These are the characteristics of an invoice adjustment:
- Always for an invoice
- Only on accounting code for an invoice
- Multiple adjustments to one invoice
- Named with prefix, IA-
Use the InvoiceAdjustment object to apply an adjustment to an Invoice object.
Supported calls
You can use this object with the following calls:
create() (opens in a new tab) (WSDL 24.0+) query() (opens in a new tab) update() (opens in a new tab) (WSDL 24.0+) delete() (opens in a new tab) (WSDL 24.0+)
Field Descriptions
| Name | Required to create | Allowed Operations | Description |
|---|---|---|---|
| AccountId | optional | Query Filter | The ID of the account that owns the invoice. Type: zns:ID Character limit: 32 Version notes: -- Values: inherited from Account.ID for the invoice owner |
| AccountingCode | optional | Create Query Filter | The accounting code for the invoice adjustment. Accounting codes (opens in a new tab) group transactions that contain similar accounting attributes. Type: string Character limit: 100 Version notes: -- Values: an accounting code that is in your BillHive Chart of Accounts and is active |
| AdjustmentDate | optional | Create Query Filter | The date when the invoice adjustment is applied. This date must be the same as the invoice's date or later. Type: Character limit: 29 Version notes: -- Values: Leave null to automatically generate the current date |
| Amount | required | Create Query Filter | The amount of the invoice adjustment. Type: decimal (currency) Character limit: 16 Version notes: -- Values: a valid currency amount |
| CancelledById | optional | Query Filter | The ID of the BillHive user who canceled the invoice adjustment. BillHive generates this read-only field only if the adjustment is canceled. Type: zns:ID Character limit: 32 Version notes: -- Values: automatically generated |
| CancelledOn | optional | Query Filter | The date when the invoice adjustment is canceled. BillHive generates this read-only field if this adjustment is canceled. Type: dateTime Character limit: 29 Version notes: -- Values: automatically generated |
| Comments | optional | Create Query Filter | Use this field to record comments about the invoice adjustment. Type: string Character limit: 255 Version notes: -- Values: inherited from Account.ID for the invoice owner |
| CreatedById | optional | Query Filter | The user ID of the person who created the invoice adjustment. Type: zns:ID Character limit: 32 Version notes: WSDL 20.0+ Values: automatically generated |
| CreatedDate | optional | Query Filter | The date the invoice adjustment was created. Type: dateTime Character limit: 29 Version notes: WSDL 20.0+ Values: automatically generated |
| CustomerName | optional | Query Filter | The name of the account that owns the associated invoice. Type: string Character limit: 50 Version notes: -- 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. |
| CustomerNumber | optional | Query Filter | The unique account number of the customer's account. Type: string Character limit: 70 Version notes: -- 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. |
| Id | optional | Query Filter | The ID of this object. Upon creation, the ID for this object is InvoiceAdjustmentId Type: zns:ID Character limit: 32 Version notes: -- Values: automatically generated |
| ImpactAmount | optional | Query Filter | The amount that changes the balance of the associated invoice. Type: decimal (currency) Character limit: 16 Version notes: -- Values: automatically calculated |
| InvoiceId | optional | Query Filter | The ID of the invoice associated with the adjustment. This field is required if you don't specify a value for the InvoiceNumber field. Type: zns:ID Character limit: 32 Version notes: -- Values: a valid invoice ID (opens in a new tab) |
| InvoiceNumber | optional | Query Filter | The unique identification number for the associated invoice. This field is required if you don't specify a value for the InvoiceId field. Type: string Character limit: 32 Version notes: -- Values: a valid invoice number (opens in a new tab) |
| ReasonCode | optional | Create Query Update Filter | A code identifying the reason for the transaction. Must be an existing reason code or empty. If you do not specify a value, BillHive uses the default reason code. Type: string Character limit: 32 Version notes: WSDL 47.0+ Values: a valid reason code |
| ReferenceId | optional | Create Query Filter | A code to reference an object external to BillHive. For example, you can use this field to reference a case number in an external system. Type: string Character limit: 60 Version notes: -- Values: a string of 60 characters or fewer |
| Status | optional | Query Update Filter | The status of the invoice adjustment. This field is required in query() calls, but is automatically generated in other calls. Type: string (enum) Character limit: 9 Version notes: -- Values: Canceled, Processed |
| TransferredToAccounting | optional | Query Update Filter | Indicates the status of the adjustment's transfer to an external accounting system, such as NetSuite. Type: string (enum) Character limit: 10 Version notes: -- Values: Processing, Yes, Error, Ignore |
| Type (opens in a new tab) | optional | Create Query Filter | Indicates whether the adjustment credits or debits the invoice amount. Type: string (enum) Character limit: 6 Version notes: -- Values: Credit, Charge2 |
| UpdatedById | optional | Query Filter | The ID of the user who last updated the invoice. Type: zns:ID Character limit: 32 Version notes: WSDL 20.0+ Values: automatically generated |
| UpdatedDate | optional | Query Filter | The date when the invoice was last updated. Type: dateTime Character limit: 29 Version notes: WSDL 20.0+ Values: automatically generated |
Additional Field Detail
Id
The ID of this object. Every object has a unique identifier that BillHive automatically assigns upon creation. You use this ID later when you work with the object. For example, if you send an amend() call to modify an existing subscription, then you need to include the specific Subscriptionobject's ID with the call.
The ID for the InvoiceAdjustment object is InvoiceAdjustmentId.
Type
Indicates whether the adjustment credits or debits the invoice amount. Set the value to Credit to create a credit memo, which gives a credit on the invoice balance or lowers its total. Set the value to Charge to create a debit memo, which increases the balance.