Adjustment lines

Line items in an adjustment represent transactions captured in that adjustment.

List adjustment lines

get/objects/accounts-payable/adjustment-line

Returns a collection with a key, ID, and link for each adjustment line. 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": "5336",
      • "id": "5336",
      • "href": "/objects/accounts-payable/adjustment-line/5336"
      },
    • {
      • "key": "5348",
      • "id": "5348",
      • "href": "/objects/accounts-payable/adjustment-line/5348"
      },
    • {
      • "key": "5296",
      • "id": "5296",
      • "href": "/objects/accounts-payable/adjustment-line/5296"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100
    }
}

Create an adjustment line

post/objects/accounts-payable/adjustment-line

Creates a new adjustment line.

SecurityOAuth2
Request
Request Body schema: application/json
required
txnAmount
required
string <decimal-precision-2>

The transaction amount for the adjustment line item in the currency specified for the transaction.

Example: "100"
required
object

Meaningful name of the account.

key
string or null

System-assigned key for the account label.

Example: "14"
id
string or null

Unique identifier for the account label.

Example: "Accounting Fees"
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.

type
string or null

The type of the 1099 form applicable to the line item.

Example: "NEC"
box
string or null

The specific box number on the 1099 form where the amount for this line item is reported. Each type of the 1099 form has different box numbers for reporting various types of income.

Example: "15A"
object
key
string

Account key

Example: "144"
id
string

Account ID

Example: "1112"
object

The general ledger account where the system posts offsets.

key
string

System-assigned key for the offset account number.

Example: "384"
id
string

Unique identifier for the offset account number.

Example: "1234.36"
object
required
object

Location to assign the expense to.

key
string or null

Location key

Example: "1"
id
string or null

Location ID

Example: "1"
object

Department to assign the expense to.

key
string or null

Department key

Example: "1"
id
string or null

Department ID

Example: "1"
object
key
string or null

Employee key

Example: "10"
id
string or null

Employee ID

Example: "EMP-10"
object
key
string or null

Project key

Example: "2"
id
string or null

Project ID

Example: "NET-XML30-2"
object
key
string or null

Customer key

Example: "13"
id
string or null

Customer ID

Example: "CUST-13"
object
key
string or null

Vendor key

Example: "357"
id
string or null

Vendor ID

Example: "1605212096809"
object
key
string or null

Item key

Example: "13"
id
string or null

Item ID

Example: "Case 13"
object
key
string or null

Warehouse key

Example: "6"
id
string or null

Warehouse ID

Example: "WH01"
object
key
string or null

Class key

Example: "731"
id
string or null

Class ID

Example: "REST_CLS_001"
object
id
string or null

Task ID

Example: "1"
key
string or null

Task key

Example: "1"
object
id
string or null

Cost Type ID

Example: "2"
key
string or null

Cost Type key

Example: "2"
object
id
string or null

Asset ID

Example: "A001"
key
string or null

Asset key

Example: "1"
object
id
string or null

Contract ID

Example: "CON-0045-1"
key
string or null

Contract key

Example: "12"
object
key
string or null

Affiliate entity key

Example: "23"
id
string or null

Affiliate entity ID

Example: "AFF-23"
object

Currency details for multi-currency companies.

object

Exchange rate details used to calculate the base amount.

date
string or null <date>

Exchange rate date for this transaction. Can be the current date, the date the transaction was issued, or the date the transaction will be paid.

Example: "2021-01-23"
rate
string

Exchange rate used to calculate the base amount from the transaction amount.

Example: "1.0789"
typeId
string or null

The type of exchange rate used to calculate the base amount from the transaction amount.

Example: "Intacct Daily Rate"
object

Payment information for the adjustment line item.

Array of objects

Tax Entries of the AP adjustment

Array
baseTaxAmount
string <decimal-precision-2>

Base tax amount.

Example: "100.00"
txnTaxAmount
string <decimal-precision-2>

Transaction tax amount. For a PATCH request, set to null if you want Sage Intacct to recalculate the amount, or set to the value you want if you don't want the system to recalculate.

Example: "100.00"
taxRate
number

Tax rate.

Example: 1.0299
object

Purchasing tax details associated with the adjustment tax entry.

Responses
201

Created

400

Bad Request

Request samples
application/json
{
  • "apAdjustment": {
    • "key": "89"
    },
  • "accountLabel": {
    • "id": "Bank Fees"
    },
  • "txnAmount": "-1800.00",
  • "totalTxnAmount": "-1800.00",
  • "dimensions": {
    • "location": {
      • "id": "1"
      },
    • "department": {
      • "id": "4"
      }
    },
  • "hasForm1099": "true",
  • "form1099": {
    • "type": "NEC",
    • "box": "7"
    },
  • "memo": "Created memo for adjustment line charges"
}
Response samples
application/json
{
  • "ia::result": {
    • "key": "5",
    • "id": "5",
    • "href": "/objects/accounts-payable/adjustment-line/5",
    • "ia::meta": {
      • "totalCount": 1
      }
    }
}

Get an adjustment line

get/objects/accounts-payable/adjustment-line/{key}

Returns detailed information for a specified adjustment line.

SecurityOAuth2
Request
path Parameters
key
required
string

System-assigned key for the adjustment line.

Example: 5296
Responses
200

OK

400

Bad Request

Request samples
Response samples
application/json
{
  • "ia::result": {
    • "id": "146",
    • "key": "146",
    • "apAdjustment": {
      • "id": "24",
      • "key": "24",
      • "href": "/objects/accounts-payable/adjustment/24"
      },
    • "glAccount": {
      • "key": "246",
      • "id": "6000",
      • "name": "G&A Salaries",
      • "href": "/objects/general-ledger/account/246"
      },
    • "overrideOffsetGLAccount": {
      • "key": "109",
      • "id": "2000",
      • "name": "Accounts Payable",
      • "href": "/objects/general-ledger/account/109"
      },
    • "accountLabel": {
      • "key": null,
      • "id": null
      },
    • "baseAmount": "-318.23",
    • "txnAmount": "-210.00",
    • "dimensions": {
      • "department": {
        },
      • "location": {
        },
      • "project": {
        },
      • "customer": {
        },
      • "vendor": {
        },
      • "employee": {
        },
      • "item": {
        },
      • "class": {
        }
      },
    • "memo": "Adj for Bil -001",
    • "currency": {
      • "exchangeRate": {
        },
      • "txnCurrency": "USD",
      • "baseCurrency": "AUD"
      },
    • "lineNumber": "1",
    • "paymentInformation": {
      • "totalBaseAmountPaid": "0.00",
      • "txnTotalPaid": "0.00",
      • "totalBaseAmountSelected": "0.00",
      • "txnTotalSelected": "0.00"
      },
    • "adjustmentType": "pa",
    • "audit": {
      • "modifiedBy": "1",
      • "createdDateTime": "2024-03-09T07:42:01Z",
      • "modifiedDateTime": "2024-03-09T07:52:39Z",
      • "createdByUser": "1"
      },
    • "hasForm1099": "false",
    • "form1099": {
      • "type": null,
      • "box": null
      },
    • "href": "/objects/accounts-payable/adjustment-line/146"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}

Update an adjustment line

patch/objects/accounts-payable/adjustment-line/{key}

Updates an existing adjustment line by setting field values. Any fields not provided remain unchanged.

SecurityOAuth2
Request
path Parameters
key
required
string

System-assigned key for the adjustment line.

Example: 5296
Request Body schema: application/json
required
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.

type
string or null

The type of the 1099 form applicable to the line item.

Example: "NEC"
box
string or null

The specific box number on the 1099 form where the amount for this line item is reported. Each type of the 1099 form has different box numbers for reporting various types of income.

Example: "15A"
object
key
string

Account key

Example: "144"
id
string

Account ID

Example: "1112"
object

The general ledger account where the system posts offsets.

key
string

System-assigned key for the offset account number.

Example: "384"
id
string

Unique identifier for the offset account number.

Example: "1234.36"
object

Meaningful name of the account.

key
string or null

System-assigned key for the account label.

Example: "14"
id
string or null

Unique identifier for the account label.

Example: "Accounting Fees"
object
object

Location to assign the expense to.

key
string or null

Location key

Example: "1"
id
string or null

Location ID

Example: "1"
object

Department to assign the expense to.

key
string or null

Department key

Example: "1"
id
string or null

Department ID

Example: "1"
object
key
string or null

Employee key

Example: "10"
id
string or null

Employee ID

Example: "EMP-10"
object
key
string or null

Project key

Example: "2"
id
string or null

Project ID

Example: "NET-XML30-2"
object
key
string or null

Customer key

Example: "13"
id
string or null

Customer ID

Example: "CUST-13"
object
key
string or null

Vendor key

Example: "357"
id
string or null

Vendor ID

Example: "1605212096809"
object
key
string or null

Item key

Example: "13"
id
string or null

Item ID

Example: "Case 13"
object
key
string or null

Warehouse key

Example: "6"
id
string or null

Warehouse ID

Example: "WH01"
object
key
string or null

Class key

Example: "731"
id
string or null

Class ID

Example: "REST_CLS_001"
object
id
string or null

Task ID

Example: "1"
key
string or null

Task key

Example: "1"
object
id
string or null

Cost Type ID

Example: "2"
key
string or null

Cost Type key

Example: "2"
object
id
string or null

Asset ID

Example: "A001"
key
string or null

Asset key

Example: "1"
object
id
string or null

Contract ID

Example: "CON-0045-1"
key
string or null

Contract key

Example: "12"
object
key
string or null

Affiliate entity key

Example: "23"
id
string or null

Affiliate entity ID

Example: "AFF-23"
object

Currency details for multi-currency companies.

object

Exchange rate details used to calculate the base amount.

date
string or null <date>

Exchange rate date for this transaction. Can be the current date, the date the transaction was issued, or the date the transaction will be paid.

Example: "2021-01-23"
rate
string

Exchange rate used to calculate the base amount from the transaction amount.

Example: "1.0789"
typeId
string or null

The type of exchange rate used to calculate the base amount from the transaction amount.

Example: "Intacct Daily Rate"
object

Payment information for the adjustment line item.

Array of objects

Tax Entries of the AP adjustment

Array
baseTaxAmount
string <decimal-precision-2>

Base tax amount.

Example: "100.00"
txnTaxAmount
string <decimal-precision-2>

Transaction tax amount. For a PATCH request, set to null if you want Sage Intacct to recalculate the amount, or set to the value you want if you don't want the system to recalculate.

Example: "100.00"
taxRate
number

Tax rate.

Example: 1.0299
object

Purchasing tax details associated with the adjustment tax entry.

Responses
200

OK

400

Bad Request

Request samples
application/json
{
  • "txnAmount": "-12.00",
  • "totalTxnAmount": "-12.00",
  • "accountLabel": {
    • "id": "Bank Interest Earned"
    },
  • "dimensions": {
    • "department": {
      • "id": "3"
      },
    • "location": {
      • "id": "2"
      }
    },
  • "memo": "Updated memo for adjustment-line"
}
Response samples
application/json
{
  • "ia::result": {
    • "key": "315783",
    • "id": "315783",
    • "href": "/objects/accounts-payable/adjustment-line/315783"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}

Delete an adjustment line.

delete/objects/accounts-payable/adjustment-line/{key}

Deletes an adjustment line.

SecurityOAuth2
Request
path Parameters
key
required
string

System-assigned key for the adjustment line.

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