Overviews
This topic provides information about creating an adjustment to an invoice, canceling an adjustment, and deleting an adjustment.
Adjusting an Invoice
To adjust an invoice:
- Create an InvoiceAdjustment (opens in a new tab).
- Specify the type of adjustment (credit or charge).
- Specify either the invoice number or the invoice ID.
- Specify the amount of the adjustment.
- Specify the adjustment date.
- Optionally, specify additional fields (comments, reference ID, accounting code.
SOAP Example
<ns1:create xmlns:ns1="http://api.billhive.com/">
<ns1:zObjects xmlns:ns2="http://object.api.billhive.com/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ns2:InvoiceAdjustment">
<ns2:AccountingCode>accountCode_0001</ns2:AccountingCode>
<ns2:AdjustmentDate>2010-08-06</ns2:AdjustmentDate>
<ns2:Amount>88</ns2:Amount>
<ns2:Comments>api test</ns2:Comments>
<ns2:InvoiceNumber>INV-1281063049406</ns2:InvoiceNumber>
<ns2:ReferenceId>re_001_225</ns2:ReferenceId>
<ns2:Type>Credit</ns2:Type>
</ns1:zObjects>
</ns1:create>Canceling an Adjustment to an Invoice
To cancel an adjustment to an invoice:
- Use the query() (opens in a new tab) call to determine ID of the adjustment that you want to cancel.
- Update the adjustment, and set the Status to Canceled.
SOAP Example
<ns1:update xmlns:ns1="http://api.billhive.com/">
<ns1:zObjects xmlns:ns2="http://object.api.billhive.com/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ns2:InvoiceAdjustment">
<ns2:Id>402881822a453a87012a4553f6cd01d8</ns2:Id>
<ns2:Status>Canceled</ns2:Status>
</ns1:zObjects>
</ns1:update>Deleting an Adjustment to an Invoice
To delete an adjustment to an invoice:
- Use the query() (opens in a new tab) call to determine ID of the adjustment that you want to cancel.
- Delete the adjustment, specifying the ID returned by the query() call.
SOAP Example
<ns1:delete xmlns:ns1="http://api.billhive.com/">
<ns1:type>InvoiceAdjustment</ns1:type>
<ns1:ids>402881822a453a87012a4559898f025f</ns1:ids>
</ns1:delete>