Adjustments

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

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 the query service to find objects that meet certain criteria and to specify properties that are returned.

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.


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


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


 
id
string
ID for the vendor.


 
 Example:  "Vendor_01"
key
string
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:  "ADJ124"
action
string
 Deprecated 
 Default:  "submit"
This field has been deprecated. Use the state field instead.
The action state of the adjustment:


    

  • submit - Default action state.
    • 

  • draft - Draft action state.
    • 



 Enum: "draft" "submit"  
state
string
 Default:  "draft"
Processing state of the adjustment:


    

  • reversed - Reversed state.
    • 

  • reversal - Reversal state.
    • 

  • draft - Draft state.
    • 

  • noValue - State when multiple lines cancel each other out, such as 10 and -10, resulting in a net zero value for the bill.
    • 

  • posted - Posted state.
    • 

  • paid - Paid state.
    • 

  • partiallyPaid - Partially paid state.
    • 

  • selected - Selected state.
The state can be modified through workflow operations like Submit and Reverse, but cannot be changed using the PATCH operation.
    • 



 Enum: "draft" "noValue" "paid" "partiallyPaid" "posted" "reversal" "reversed" "selected"  
 Example:  "paid"
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
Unique key for the tax solution.


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


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


 
key
string
Unique key for the attachment.


 
 Example:  "1"
id
string
ID for the attachment.


 
 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
Unique key for the adjustment summary.


 
 Example:  "280"
id
string
ID for the adjustment summary.


 
 Example:  "280"
glPostingDate
string <date> 
The date when the adjustment summary was posted to the general ledger.


 
 Example:  "2021-01-23"
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
Unique key for the contact.


 
 Example:  "916"
id
string or null
ID 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
Unique key for the contact.


 
 Example:  "916"
id
string
ID 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"
key
string
System-assigned key for the adjustment line item.


 
 Example:  "1"
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
string
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": "ADJ124",
  • "vendor": {
    • "id": "GK183"
    },
  • "createdDate": "2024-03-05",
  • "currency": {
    • "baseCurrency": "USD",
    • "txnCurrency": "USD"
    },
  • "lines": [
    • {
      • "glAccount": {
        },
      • "txnAmount": "150.00",
      • "dimensions": {
        }
      }
    ]
}
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.


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


 
 Example:  67
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. With appropriate permissions, you can edit an adjustment if the adjustment is in a Posted state and the books are not yet closed. For more information, see Edit an AP adjustment in the Sage Intacct Help Center. 


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


 
 Example:  67
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:  "ADJ124"
action
string
 Deprecated 
 Default:  "submit"
This field has been deprecated. Use the state field instead.
The action state of the adjustment:


    

  • submit - Default action state.
    • 

  • draft - Draft action state.
    • 



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


 
id
string
ID for the vendor.


 
 Example:  "Vendor_01"
key
string
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
Unique key for the tax solution.


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


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


 
key
string
Unique key for the attachment.


 
 Example:  "1"
id
string
ID for the attachment.


 
 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
Unique key for the adjustment summary.


 
 Example:  "280"
id
string
ID for the adjustment summary.


 
 Example:  "280"
glPostingDate
string <date> 
The date when the adjustment summary was posted to the general ledger.


 
 Example:  "2021-01-23"
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
Unique key for the contact.


 
 Example:  "916"
id
string or null
ID 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
Unique key for the contact.


 
 Example:  "916"
id
string
ID 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 
key
string
System-assigned key for the adjustment line item.


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


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


 
 Example:  67
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
    }
}