Adjustments

An adjustment is a transaction that applies a credit or debit in order to modify the amount owed by a customer.

List adjustments

get/objects/accounts-receivable/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": "259",
      • "id": "259",
      • "href": "/objects/accounts-receivable/adjustment/259"
      },
    • {
      • "key": "295",
      • "id": "295",
      • "href": "/objects/accounts-receivable/adjustment/295"
      },
    • {
      • "key": "296",
      • "id": "296",
      • "href": "/objects/accounts-receivable/adjustment/296"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}
Create an adjustment
post/objects/accounts-receivable/adjustment
Creates a new adjustment.


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


 
 Example:  "2021-01-23"
adjustmentNumber
string or null
Number that can be used to track the AR adjustment.


 
 Example:  "ADJ001"
object
Associated contacts for the AR adjustment.


 
object
Customer contact to invoice for this sale.


 
key
string
System-assigned key for the contact.


 
 Example:  "916"
id
string
Name of the contact.


 
 Example:  "Power Aerospace Materials (C1)"
object
Customer contact for shipping.


 
key
string
System-assigned key for the contact.


 
 Example:  "312"
id
string
Name of the ship-to contact.


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


 
state
string
 Default:  "posted"
Processing state of the AR adjustment.
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 or null
Description of the AR adjustment.


 
 Example:  "Computer Hardware & Software Expenses 03/01/20 - 08/31/21 Subscription charges."
documentNumber
string
Invoice number selected as a reference for the adjustment.


 
 Example:  "INV-1602"
object
For multi-currency companies, the base currency for the adjustment.


 
currency
string
Base currency


 
 Example:  "USD"
totalDue
string <decimal-precision-2> 
Total amount due.


 
 Example:  "251464.01"
paidDate
string or null <date> 
Payment date


 
 Example:  "2022-11-01"
object
For multi-currency companies, the transaction currency for the adjustment.


 
 Example:  "USD"
currency
required
string
Transaction currency


 
 Example:  "INR"
object
Exchange rate details used to calculate the base amount.


 
date
string <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
Exchange rate type used to calculate the base amount from the transaction amount.


 
 Example:  "1"
object
The customer who is the target of the AR adjustment.


 
 Example:  "1"
id
required
string
ID of the customer.


 
 Example:  "Customer_01"
key
string
System-assigned key for the customer.


 
 Example:  "16"
name
string
Name of the customer.


 
 Example:  "Logic Solutions"
glPostingDate
string <date> 
GL posting date.


 
 Example:  "2023-03-24"
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
Name or other unique identifier for 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:  "Sales01"
object
The payment summary details for this adjustment. Summaries are collections of the same types of transactions grouped together for processing.


 
 Example:  "AR Summary: 2022/01/01 Batch"
id
required
string
Name for the AR summary. The system uses this name to identify the summary throughout the Accounts Receivable application.


 
 Example:  "AR Summary: 2022/01/01 Batch"
key
integer
System-assigned key to uniquely identify the summary.


 
 Example:  280
Array of objects
Line items of the AR adjustment.


 
 Array 
memo
string
Memo to describe the line item.


 
 Example:  "50 USD credit"
object
Transaction currency for the line item.


 
 Example:  "100"
object
Exchange rate details used to calculate the base amount.


 
object
Label for the AR account.


 
Array of objects
Tax Entries of the AR adjustment


 
object
Header level details for the AR adjustment's line entries.


 
object
 
 Example:  {"location":{"id":"1"}}
object
 
 Example:  "2995"
Responses 
201
Created


400
Bad Request


Request samples 
application/json
{
  • "customer": {
    • "id": "C-00005"
    },
  • "createdDate": "2023-06-28",
  • "description": "Lyon USD Adj",
  • "adjustmentSummary": {
    • "id": "AR Summary: 2022/01/01 Batch"
    },
  • "baseCurrency": {
    • "paidDate": "2022-11-15",
    • "currency": "USD"
    },
  • "txnCurrency": {
    • "currency": "USD"
    },
  • "lines": [
    • {
      • "txnCurrency": {
        },
      • "glAccount": {
        },
      • "dimensions": {
        }
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": {
    • "id": "270",
    • "key": "270",
    • "href": "/objects/accounts-receivable/adjustment/270"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Get an adjustment
get/objects/accounts-receivable/adjustment/{key}
Returns detailed information for a specified adjustment.


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


 
 Example:  99
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "id": "288",
    • "key": "288",
    • "txnType": "ra",
    • "adjustmentNumber": "adj-1",
    • "state": "posted",
    • "customer": {
      • "id": "1",
      • "key": "1",
      • "name": "Power Aerospace Materials",
      • "totalDue": "-17909.55",
      • "href": "/objects/accounts-receivable/customer/1"
      },
    • "documentNumber": "ADJ008567",
    • "description": "Adjustment 3",
    • "createdDate": "2024-09-24",
    • "entity": {
      • "key": "1",
      • "id": "1",
      • "name": "United States of America",
      • "href": "/objects/company-config/entity/1"
      },
    • "glPostingDate": "2024-09-24",
    • "adjustmentSummary": {
      • "id": "AR Summary: 2022/01/01 Batch",
      • "key": 280,
      • "href": "/objects/accounts-receivable/summary/280"
      },
    • "baseCurrency": {
      • "paidDate": "2024-07-19",
      • "currency": "AUD",
      • "totalAmountEntered": "-150.00",
      • "totalSelected": "0.00",
      • "totalPaid": "0.00",
      • "totalDue": "-150.00"
      },
    • "txnCurrency": {
      • "currency": "AUD",
      • "totalEntered": "-150.00",
      • "totalSelected": "0.00",
      • "totalPaid": "0.00",
      • "totalDue": "-150.00"
      },
    • "exchangeRate": {
      • "date": "2024-07-17",
      • "typeId": "Intacct Daily Rate",
      • "rate": "1"
      },
    • "contacts": {
      • "billTo": {
        },
      • "shipTo": {
        }
      },
    • "moduleKey": "4.AR",
    • "audit": {
      • "createdDateTime": "2024-09-24T13:19:27Z",
      • "modifiedDateTime": "2024-09-24T14:01:12Z",
      • "createdBy": "1",
      • "modifiedBy": "1"
      },
    • "taxSolution": {
      • "key": "1",
      • "id": "Australia - GST",
      • "href": "/objects/tax/tax-solution/1"
      },
    • "attachment": {
      • "id": null,
      • "key": null
      },
    • "lines": [
      • {
        }
      ],
    • "href": "/objects/accounts-receivable/adjustment/288"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Update an adjustment
patch/objects/accounts-receivable/adjustment/{key}
Updates an existing adjustment by setting field values. Any fields not provided remain unchanged.


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


 
 Example:  99
Request Body schema: application/json
adjustmentNumber
string or null
Number that can be used to track the AR adjustment.


 
 Example:  "ADJ001"
object
Associated contacts for the AR adjustment.


 
object
Customer contact to invoice for this sale.


 
key
string
System-assigned key for the contact.


 
 Example:  "916"
id
string
Name of the contact.


 
 Example:  "Power Aerospace Materials (C1)"
object
Customer contact for shipping.


 
key
string
System-assigned key for the contact.


 
 Example:  "312"
id
string
Name of the ship-to contact.


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


 
state
string
 Default:  "posted"
Processing state of the AR adjustment.
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 or null
Description of the AR adjustment.


 
 Example:  "Computer Hardware & Software Expenses 03/01/20 - 08/31/21 Subscription charges."
documentNumber
string
Invoice number selected as a reference for the adjustment.


 
 Example:  "INV-1602"
object
For multi-currency companies, the base currency for the adjustment.


 
currency
string
Base currency


 
 Example:  "USD"
totalDue
string <decimal-precision-2> 
Total amount due.


 
 Example:  "251464.01"
paidDate
string or null <date> 
Payment date


 
 Example:  "2022-11-01"
object
For multi-currency companies, the transaction currency for the adjustment.


 
currency
string
Transaction currency


 
 Example:  "INR"
object
Exchange rate details used to calculate the base amount.


 
date
string <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
Exchange rate type used to calculate the base amount from the transaction amount.


 
 Example:  "1"
object
The customer who is the target of the AR adjustment.


 
key
string
System-assigned key for the customer.


 
 Example:  "16"
id
string
ID of the customer.


 
 Example:  "Customer_01"
name
string
Name of the customer.


 
 Example:  "Logic Solutions"
createdDate
string <date> 
Date the adjustment was created.


 
 Example:  "2021-01-23"
glPostingDate
string <date> 
GL posting date.


 
 Example:  "2023-03-24"
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
Name or other unique identifier for 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:  "Sales01"
object
The payment summary details for this adjustment. Summaries are collections of the same types of transactions grouped together for processing.


 
key
integer
System-assigned key to uniquely identify the summary.


 
 Example:  280
id
string
Name for the AR summary. The system uses this name to identify the summary throughout the Accounts Receivable application.


 
 Example:  "AR Summary: 2022/01/01 Batch"
Array of objects
Line items of the AR adjustment.


 
 Array 
memo
string
Memo to describe the line item.


 
 Example:  "50 USD credit"
object
Transaction currency for the line item.


 
object
Exchange rate details used to calculate the base amount.


 
object
Label for the AR account.


 
Array of objects
Tax Entries of the AR adjustment


 
object
Header level details for the AR adjustment's line entries.


 
object
 
object
 
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "description": "May 2023 Refund"
}
Response samples 
application/json
{
  • "ia::result": {
    • "id": "16855",
    • "key": "16855",
    • "href": "/objects/accounts-receivable/adjustment/16855"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Delete an adjustment
delete/objects/accounts-receivable/adjustment/{key}
Deletes an adjustment. An adjustment can be deleted if it has not yet been applied to an invoice.


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


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