Account allocation reversals

Account allocation reverse creates offset entries to undo previous dynamic account allocation calculations.

List account allocation reversals

get/objects/general-ledger/account-allocation-reverse

Returns a collection with a key, ID, and link for each account allocation reversal.

SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples
Response samples
application/json
{
  • "ia::result": [
    • {
      • "key": "16",
      • "id": "16",
      • "href": "/objects/general-ledger/account-allocation-reverse/16"
      },
    • {
      • "key": "20",
      • "id": "20",
      • "href": "/objects/general-ledger/account-allocation-reverse/20"
      },
    • {
      • "key": "21",
      • "id": "21",
      • "href": "/objects/general-ledger/account-allocation-reverse/21"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}

Get an account allocation reversal

get/objects/general-ledger/account-allocation-reverse/{key}

Returns detailed information for a specified account allocation reversal.

SecurityOAuth2
Request
path Parameters
key
required
string

System-assigned key for the account allocation reversal.

Example: 178
Responses
200

OK

400

Bad Request

Request samples
Response samples
application/json
{
  • "ia::result": {
    • "id": "21",
    • "key": "21",
    • "glAccountAllocation": {
      • "id": "29",
      • "key": "29",
      • "href": "/objects/general-ledger/account-allocation/29"
      },
    • "glAccount": {
      • "id": null,
      • "key": null,
      • "name": null
      },
    • "useSourceAccount": true,
    • "audit": {
      • "createdDateTime": "2024-06-25T12:16:48Z",
      • "modifiedDateTime": "2024-06-25T12:58:13Z",
      • "createdBy": "1",
      • "modifiedBy": "1"
      },
    • "dimensions": {
      • "location": {
        },
      • "department": {
        },
      • "project": {
        },
      • "customer": {
        },
      • "vendor": {
        },
      • "employee": {
        },
      • "item": {
        },
      • "class": {
        },
      • "contract": {
        },
      • "warehouse": {
        }
      },
    • "href": "/objects/general-ledger/account-allocation-reverse/21"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}

Update an account allocation reversal

patch/objects/general-ledger/account-allocation-reverse/{key}

Updates an existing account allocation reversal by setting field values. Any fields not provided remain unchanged.

SecurityOAuth2
Request
path Parameters
key
required
string

System-assigned key for the account allocation reversal.

Example: 178
Request Body schema: application/json
useSourceAccount
boolean
Default: false

Specify if the original source account is included in the reversal.

Example: true
object

General ledger account associated with the reversal.

key
string or null

System-assigned unique key for the account.

Example: "1"
id
string or null

Unique identifier for the account.

Example: "1000"
object

Dimension overrides for the account allocation reversal.

object

Dimension override for class, applies only if the dimension treatment for class is set to not considered.

key
string or null

Unique key for the class.

Example: "6"
id
string or null

Unique identifier for the class.

Example: "4"
object

Dimension override for customer, applies only if the dimension treatment for customer is set to not considered.

key
string or null

Unique key for the customer.

Example: "1"
id
string or null

Unique identifier for the customer.

Example: "1"
object

Dimension override for employee, applies only if the dimension treatment for employee is set to not considered.

key
string or null

Unique key for the employee.

Example: "27"
id
string or null

Unique identifier for the employee.

Example: "12"
object

Dimension override for department, applies only if the dimension treatment for department is set to not considered.

key
string or null

Unique key for the department.

Example: "6"
id
string or null

Unique identifier for the department.

Example: "6"
object

Dimension override for location, applies only if the dimension treatment for location is set to not considered.

key
string or null

Unique key for the location.

Example: "72"
id
string or null

Unique identifier for the location.

Example: "AZ"
object

Dimension override for project, applies only if the dimension treatment for project is set to not considered.

key
string or null

Unique key for the project.

Example: "8"
id
string or null

Unique identifier for the project.

Example: "8"
object

Dimension override for vendor, applies only if the dimension treatment for vendor is set to not considered.

key
string or null

Unique key for the vendor.

Example: "48"
id
string or null

Unique identifier for the vendor.

Example: "202"
object

Dimension override for warehouse, applies only if the dimension treatment for warehouse is set to not considered.

key
string or null

Unique key for the warehouse.

Example: "2"
id
string or null

Unique identifier for the warehouse.

Example: "WH02"
object

Dimension override for item, applies only if the dimension treatment for item is set to not considered.

key
string or null

Unique key for the item.

Example: "13"
id
string or null

Unique identifier for the item.

Example: "Case 13"
href
string

URL endpoint for the item.

Example: "/objects/inventory-control/item/13"
object

Dimension override for contract, applies only if the dimension treatment for contract is set to not considered.

key
string or null

Unique key for the contract.

Example: "12"
id
string or null

Unique identifier for the contract.

Example: "CON-0045-1"
Responses
200

OK

400

Bad Request

Request samples
application/json
{
  • "glAccount": {
    • "id": "1000"
    },
  • "useSourceAccount": false
}
Response samples
application/json
{
  • "ia::result": {
    • "key": "21",
    • "id": "21",
    • "href": "/objects/general-ledger/account-allocation-reverse/21"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}