Adjustments

Adjustments allow you to modify the amount owed to a vendor, either increasing or decreasing it as necessary.

Please be aware that this object is currently "Uncertified", signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.

List adjustments

get/objects/accounts-payable/adjustment

Returns a collection with a key, ID, and link for each adjustment. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned.

Permissions and other requirements
SubscriptionAccounts Payable
User typeBusiness, Employee, Project Manager, Warehouse
PermissionsList, View Adjustments
SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "186",
      • "id": "186",
      • "href": "/objects/accounts-payable/adjustment/186"
      },
    • {
      • "key": "187",
      • "id": "187",
      • "href": "/objects/accounts-payable/adjustment/187"
      },
    • {
      • "key": "319",
      • "id": "319",
      • "href": "/objects/accounts-payable/adjustment/319"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100
    }
}
Create an adjustment
post/objects/accounts-payable/adjustment
Creates a new adjustment.



Permissions and other requirements



SubscriptionAccounts Payable


User typeBusiness


PermissionsAdd Adjustments







SecurityOAuth2 
Request 
Request Body schema: application/json
createdDate
required
string <date> 
The date when the adjustment was created.


 
 Example:  "2021-01-23"
required
object
Vendor associated with the adjustment.


 
id
string
Unique identifier for the vendor. This value is the same as the key for this object.


 
 Example:  "Vendor_01"
key
string
System-assigned unique key for the vendor.


 
 Example:  "Vendor_01"
adjustmentNumber
string
Adjustment number associated with the adjustment.
You must specify a unique adjustment number unless document sequencing is configured, in which case the ID is auto-generated.


 
 Example:  "2"
action
string
 Default:  "submit"
The action state of the adjustment:


    

  • submit - Default action state.
    • 

  • draft - Draft action state.
    • 



 Enum: "draft" "submit"  
 Example:  "draft"
description
string
Detailed explanation of the adjustment.


 
 Example:  "Computer Hardware & Software Expenses 03/01/20 - 08/31/21 Subscription charges."
isTaxInclusive
boolean
 Default:  false
Set to true if the adjustment amount already includes taxes.


 
 Example:  false
object
Tax solution details for this adjustment.


 
key
string or null
System-assigned key to uniquely identify the tax solution.


 
 Example:  "4"
id
string or null
Unique identifier or name of the tax solution.


 
 Example:  "Australia GST"
object
Supporting document for the adjustment.


 
key
string
System-assigned key for the supporting document.


 
 Example:  "1"
id
string
ID for the supporting document.


 
 Example:  "adj-01"
object
Details of the summary for this adjustment. Summaries are collections of the same types of transactions grouped together for processing.


 
key
string
System-assigned key to uniquely identify the adjustment summary.


 
 Example:  "280"
id
string
Unique identifier for the adjustment summary. This value is the same as the key for this object.


 
 Example:  "280"
object
 
txnCurrency
required
string
Transaction currency


 
 Example:  "GBP"
baseCurrency
required
string
Base currency


 
 Example:  "USD"
exchangeRateDate
string <date> 
Exchange rate date


 
 Example:  "2014-01-08"
exchangeRateTypeId
string
Exchange rate type


 
 Example:  "Intacct Daily Rate"
exchangeRate
number
Exchange rate


 
 Example:  0.78
object
Contacts for this adjustment. If not specified, the vendor contacts will be used.


 
object
The vendor contact to be paid.


 
key
string or null
System-assigned key for the contact.


 
 Example:  "916"
id
string or null
Unique identifier for the contact.


 
 Example:  "Power Aerospace Materials(C1)"
object
Tax-related information for the pay-to contact.


 
object
The vendor contact for return of the purchase.


 
key
string
System-assigned key for the contact.


 
 Example:  "916"
id
string
Unique identifier for the contact.


 
 Example:  "Power Aerospace Materials(C1)"
referenceNumber
string
A number, such as a purchase order or account number, useful for searches or reports. This number appears on the GL Details report and is printed on checks and vendor stubs.


 
 Example:  "INV-902852"
object
Payment information for the adjustment.


 
Array of objects
 
 Array 
required
object
 
txnAmount
required
string <decimal-precision-2> 
The transaction amount for the adjustment line item in the currency specified for the transaction.


 
 Example:  "100"
baseAmount
string <decimal-precision-2> 
For multi-currency companies, the transaction amount in the base currency.


 
 Example:  "100"
totalTxnAmount
string <decimal-precision-2> 
Total transaction amount, including tax, for tax-inclusive adjustments.


 
 Example:  "100.00"
memo
string
Additional notes or comments about the adjustment line item for reference.


 
 Example:  "Service adjustments"
hasForm1099
boolean
Set to true to add the line item amount to the vendor 1099 form.


 
 Example:  false
object
Details related to the 1099 form for the line item.


 
object
The general ledger account where the system posts offsets.


 
object
Meaningful name of the account.


 
object
 
object
Currency details for multi-currency companies.


 
object
Payment information for the adjustment line item.


 
Array of objects
Tax Entries of the AP adjustment


 
Responses 
201
Created


400
Bad Request


Request samples 
application/json
{
  • "adjustmentNumber": "credit-001",
  • "vendor": {
    • "id": "1099 Int"
    },
  • "description": "Adj for Bil -001",
  • "referenceNumber": "Bill-001-02",
  • "adjustmentSummary": {
    • "glPostingDate": "2024-03-05"
    },
  • "createdDate": "2024-03-05",
  • "contacts": {
    • "payTo": {
      • "id": "1099 Int"
      },
    • "returnTo": {
      • "id": "1099 Int"
      }
    },
  • "isTaxInclusive": false,
  • "currency": {
    • "baseCurrency": "AUD",
    • "txnCurrency": "USD",
    • "exchangeRateDate": "2024-03-08",
    • "exchangeRateTypeId": "Intacct Daily Rate",
    • "exchangeRate": 1.5154
    },
  • "attachment": {
    • "id": "Adj_Bill_001"
    },
  • "lines": [
    • {
      • "glAccount": {
        },
      • "txnAmount": "5.00",
      • "totalTxnAmount": "25.00",
      • "dimensions": {
        },
      • "memo": "Adj for Bil -001"
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "26",
    • "id": "26",
    • "href": "/objects/accounts-payable/adjustment/26"
    },
  • "ia::meta": {
    • "totalCount": 1
    }
}
Get an adjustment
get/objects/accounts-payable/adjustment/{key}
Returns detailed information for a specified adjustment.



Permissions and other requirements



SubscriptionAccounts Payable


User typeBusiness, Employee, Project Manager, Warehouse


PermissionsList, View Adjustments







SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for the adjustment.


 
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "id": "67",
    • "key": "67",
    • "recordType": "pa",
    • "adjustmentNumber": "credit-001",
    • "state": "posted",
    • "vendor": {
      • "id": "1099 Int",
      • "key": "1099 Int",
      • "name": "1099 Int",
      • "totalDue": "28.94",
      • "href": "/objects/accounts-payable/vendor/1099 Int"
      },
    • "referenceNumber": "Bill-001-02",
    • "description": "Adj for Bil -001",
    • "createdDate": "2024-03-05",
    • "audit": {
      • "createdDateTime": "2024-03-05T00:00:00Z",
      • "modifiedDateTime": "2024-03-20T09:29:02Z",
      • "createdBy": "1",
      • "modifiedBy": "1"
      },
    • "adjustmentSummary": {
      • "glPostingDate": "2024-03-05",
      • "name": "Adjustments: 2024/03/05 Batch",
      • "id": "45",
      • "key": "45",
      • "state": "open",
      • "preventGLPosting": false,
      • "href": "/objects/accounts-payable/adjustment-summary/45"
      },
    • "currency": {
      • "baseCurrency": "AUD",
      • "txnCurrency": "USD",
      • "exchangeRateDate": "2024-03-08",
      • "exchangeRateTypeId": "Intacct Daily Rate",
      • "exchangeRate": 1.5154
      },
    • "totalEntered": "7.58",
    • "totalBaseAmountDue": "7.58",
    • "txnTotalEntered": "5.00",
    • "txnTotalDue": "5.00",
    • "contacts": {
      • "payTo": {
        },
      • "returnTo": {
        }
      },
    • "attachment": {
      • "id": "Adj_Bill_001",
      • "key": "8",
      • "href": "/objects/company-config/attachment/8"
      },
    • "moduleKey": "3.AP",
    • "isTaxInclusive": false,
    • "lines": [
      • {
        }
      ],
    • "href": "/objects/accounts-payable/adjustment/67"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Update an adjustment
patch/objects/accounts-payable/adjustment/{key}
Updates an adjustment by setting field values. Any fields not provided remain unchanged.


Note:


    

  • Adjustment must be in a Posted state.
    • 

  • Books must not be closed.
    • 

  • Requires Edit Accounts Payable permission for Adjustments.
    • 



Special Cases:


    

  • Type cannot be edited after posting. Delete or reverse and create a new adjustment to change type.
    • 

  • For project-associated adjustments, changing the date has specific requirements, especially for paid adjustments.
    • 

  • To change GL account for paid adjustments, reclassify if reclassification is allowed and permissions are met.
    • 

  • To change amount after applying to a bill, create a new debit or credit memo.
    • 




Permissions and other requirements



SubscriptionAccounts Payable


User typeBusiness


PermissionsAdd Adjustments







SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for the adjustment.


 
Request Body schema: application/json
adjustmentNumber
string
Adjustment number associated with the adjustment.
You must specify a unique adjustment number unless document sequencing is configured, in which case the ID is auto-generated.


 
 Example:  "2"
action
string
 Default:  "submit"
The action state of the adjustment:


    

  • submit - Default action state.
    • 

  • draft - Draft action state.
    • 



 Enum: "draft" "submit"  
 Example:  "draft"
object
Vendor associated with the adjustment.


 
id
string
Unique identifier for the vendor. This value is the same as the key for this object.


 
 Example:  "Vendor_01"
key
string
System-assigned unique key for the vendor.


 
 Example:  "Vendor_01"
description
string
Detailed explanation of the adjustment.


 
 Example:  "Computer Hardware & Software Expenses 03/01/20 - 08/31/21 Subscription charges."
createdDate
string <date> 
The date when the adjustment was created.


 
 Example:  "2021-01-23"
isTaxInclusive
boolean
 Default:  false
Set to true if the adjustment amount already includes taxes.


 
 Example:  false
object
Tax solution details for this adjustment.


 
key
string or null
System-assigned key to uniquely identify the tax solution.


 
 Example:  "4"
id
string or null
Unique identifier or name of the tax solution.


 
 Example:  "Australia GST"
object
Supporting document for the adjustment.


 
key
string
System-assigned key for the supporting document.


 
 Example:  "1"
id
string
ID for the supporting document.


 
 Example:  "adj-01"
object
Details of the summary for this adjustment. Summaries are collections of the same types of transactions grouped together for processing.


 
key
string
System-assigned key to uniquely identify the adjustment summary.


 
 Example:  "280"
id
string
Unique identifier for the adjustment summary. This value is the same as the key for this object.


 
 Example:  "280"
object
 
exchangeRateDate
string <date> 
Exchange rate date


 
 Example:  "2014-01-08"
exchangeRateTypeId
string
Exchange rate type


 
 Example:  "Intacct Daily Rate"
exchangeRate
number
Exchange rate


 
 Example:  0.78
baseCurrency
string
Base currency


 
 Example:  "USD"
txnCurrency
string
Transaction currency


 
 Example:  "GBP"
object
Contacts for this adjustment. If not specified, the vendor contacts will be used.


 
object
The vendor contact to be paid.


 
key
string or null
System-assigned key for the contact.


 
 Example:  "916"
id
string or null
Unique identifier for the contact.


 
 Example:  "Power Aerospace Materials(C1)"
object
Tax-related information for the pay-to contact.


 
object
The vendor contact for return of the purchase.


 
key
string
System-assigned key for the contact.


 
 Example:  "916"
id
string
Unique identifier for the contact.


 
 Example:  "Power Aerospace Materials(C1)"
referenceNumber
string
A number, such as a purchase order or account number, useful for searches or reports. This number appears on the GL Details report and is printed on checks and vendor stubs.


 
 Example:  "INV-902852"
object
Payment information for the adjustment.


 
Array of objects
 
 Array 
baseAmount
string <decimal-precision-2> 
For multi-currency companies, the transaction amount in the base currency.


 
 Example:  "100"
txnAmount
string <decimal-precision-2> 
The transaction amount for the adjustment line item in the currency specified for the transaction.


 
 Example:  "100"
totalTxnAmount
string <decimal-precision-2> 
Total transaction amount, including tax, for tax-inclusive adjustments.


 
 Example:  "100.00"
memo
string
Additional notes or comments about the adjustment line item for reference.


 
 Example:  "Service adjustments"
hasForm1099
boolean
Set to true to add the line item amount to the vendor 1099 form.


 
 Example:  false
object
Details related to the 1099 form for the line item.


 
object
 
object
The general ledger account where the system posts offsets.


 
object
Meaningful name of the account.


 
object
 
object
Currency details for multi-currency companies.


 
object
Payment information for the adjustment line item.


 
Array of objects
Tax Entries of the AP adjustment


 
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "ia::result": {
    • "key": "26",
    • "id": "26",
    • "href": "/objects/accounts-payable/adjustment/625459"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Response samples 
application/json
{
  • "description": "Bill -001 adjustment-1"
}
Delete an adjustment
delete/objects/accounts-payable/adjustment/{key}
Deletes an adjustment. Adjustments not applied to a bill can be deleted.



Permissions and other requirements



SubscriptionAccounts Payable


User typeBusiness


PermissionsList, Delete Adjustments







SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for the adjustment.


 
Responses 
204
No Content


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "ia::error": {
      • "code": "invalidRequest",
      • "message": "A POST request requires a payload",
      • "errorId": "REST-1028",
      • "additionalInfo": {
        },
      • "supportId": "Kxi78%7EZuyXBDEGVHD2UmO1phYXDQAAAAo"
      }
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 0,
    • "totalError": 1
    }
}
Query adjustments
post/services/core/query
Queries an object for filtered data.


SecurityOAuth2 
Request 
Request Body schema: application/json
object
string
Object type to query, in the form <application-name>/<object name>. For custom objects use platform-apps/nsp::<object-name>.


 
 Example:  "accounts-payable/adjustment"
fields
Array of strings
List of fields to include in the response. Can be any combination of these:


    

  • The name of a field in the object that you are querying, such as id.
    

    • 

  • The name of a field in a related object, using the form relatedObjectName.fieldName, such as vendor.id.
    

    • 

  • The result of an aggregate function run against the values in the returned objects. Use the form function:fieldName, such as min:startDate to return the earliest starting date. Valid function names are:
    

      

    • count
      • 

    • avg
      • 

    • sum
      • 

    • min
      • 

    • max
      • 

    

    • 

  • The result of an aggregate function run against the values in related objects, using the form function:relatedObjectName.fieldName, such as max:vendor.creditLimit. The same functions are supported as for object fields.
    

    • 



 
 Example:  ["key","id","max:vendor.creditLimit"]
Array of equal (object) or not equal (object) or less than (object) or (less than or equal (object)) or greater than (object) or (greater than or equal (object)) or in (object) or not in (object) or between (object) or not between (object) or contains (object) or does not contain (object) or starts with (object) or does not start with (object) or ends with (object) or does not end with (object)
Filter conditions to select the objects to return based on their field values. You use operators and conditions to build your filter, such as {"$eq":{"status":"active"}} to select objects in which status is equal to "active".


 
 Example:  [{"$eq":{"status":"active"}},{"$gt":{"totalDue":"1000"}},{"$contains":{"name":"Acme"}}]
 Array 
Any of:
Field value must be equal to this specified value.


For date fields, you can use these macro values that are relative to the current date or the asOfDate in filterParameters, if set:







    

  • today

  • currentWeek

  • currentMonth

  • currentQuarter

  • currentYear





    

  • yesterday

  • lastWeek

  • priorMonth

  • priorQuarter

  • priorYear









These are most useful for queries that you want to save and use repeatedly, such as for views or reports. Just change the asOfDate each time to retrieve the same data set for different time periods.


For example, {"eq":{"postingDate":"priorYear"}}.


object
The field name and value to be compared with object values.


 
 Example:  {"status":"active"}
filterExpression
string
 Default:  "and"
Logical operators to apply when there are multiple filter conditions. The conditions in the filters array are implicitly numbered starting at 1. Supports and, or, and grouping with parentheses.


Shortcuts:


    

  • and by itself means that all conditions must be true.
    • 

  • or by itself means that at least one condition must be true.
    • 



 
 Example:  "(1 and 2) or 3"
object

Pre-defined filter options.


 
asOfDate
string <date> 
The "as of" date to use with any relative date comparisons in filters. For example, if asOfDate is set to "2022-04-01" then priorMonth will be "03".


The current date is used if asOfDate is not set.


 
 Example:  "2022-04-01"
includeHierarchyFields
boolean
 Default:  false
Set to true to include hierarchical structure information with each object in the response.


 
 Example:  false
caseSensitiveComparison
boolean
 Default:  true
Queries are case-sensitive by default. Set to false to ignore case in a query.


 
 Example:  true
includePrivate
boolean
 Default:  false
By default, in a multi-entity company, queries from the top-level entity do not access data in private entities. Set includePrivate to true if you want to query data in private entities.


 
 Example:  false
Array of objects
Set the order of the results by specifying field names to sort by and whether they should be in ascending or descending order.


 
 Example:  [{"totalDue":"asc"},{"lastPaymentMadeDate":"desc"}]
 Array 
property name*
additional property
string
 Enum: "asc" "desc"  
start
integer
First record of the result set to include in the response.


 
 Example:  1
size
integer
Number of records to include in the response.


 
 Example:  100
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "object": "accounts-payable/adjustment",
  • "filters": [
    • {
      • "$eq": {
        }
      }
    ],
  • "fields": [
    • "key",
    • "id",
    • "adjustmentNumber",
    • "state",
    • "totalEntered",
    • "totalBaseAmountDue",
    • "createdDate"
    ],
  • "orderBy": [
    • {
      • "id": "asc"
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "67",
      • "id": "67",
      • "adjustmentNumber": "credit-001",
      • "state": "posted",
      • "totalEntered": "7.58",
      • "totalBaseAmountDue": "7.58",
      • "createdDate": "2024-03-05"
      },
    • {
      • "key": "68",
      • "id": "68",
      • "adjustmentNumber": "credit-002",
      • "state": "pending",
      • "totalEntered": "15.00",
      • "totalBaseAmountDue": "15.00",
      • "createdDate": "2024-03-10"
      },
    • {
      • "key": "69",
      • "id": "69",
      • "adjustmentNumber": "credit-003",
      • "state": "posted",
      • "totalEntered": "20.00",
      • "totalBaseAmountDue": "20.00",
      • "createdDate": "2024-03-15"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}