Adjustment is for line item adjustment on transactions. It can be for discounts or for surcharges.
api_url depends on which host your account is assigned to. It will be the same URL you log in with.
| URL | https://api_url/v1/adjustment |
| Supported Methods | GET |
| Description | Returns all Adjustment Types defined for the firm.
Adjustments can be applied to line items of the following document types: Bills, Invoices, Orders, and Quotes |
Accepted Query Formats
| GET /adjustment[.format] | retrieve all adjustments |
| GET /adjustment/1[.format] | retrieve adjustment with ID = 1 |
Elements
| id | width="80%" Unique ID assigned to Adjustment record |
| name | Name of the Adjustment Type. The defaults are discount and surcharge. |
| default_percentage | A percentage of the line item value, which can be either positive or negative, suggested to the user when creating line items for business documents (Bills, Invoices, Orders, Quotes). |
| default_amount | A nominal amount to be applied to the line item value, which can be either positive or negative, suggested to the user when creating line items for business documents. |
Examples
Retrieve all adjustment types in XML format:
$ curl -i --header "VERSACCOUNTS_AUTHORIZATION:409696900e0b3f5a4297e3cd5823f734f0095e66" https://api_ur/v1/adjustment.xml
<?xml version="1.0" encoding="UTF-8"?>
<adjustments>
<adjustment>
<id>329</id>
<name>Discount</name>
<default_percentage></default_percentage>
<default_amount></default_amount>
</adjustment>
<adjustment>
<id>330</id>
<name>Surcharge</name>
<default_percentage></default_percentage>
<default_amount></default_amount>
</adjustment>
</adjustments
Comments and Suggestions
0 comments
Please sign in to leave a comment.
Related articles