AR advance transaction templates

AR advance transaction templates define how to create new advance transactions in Sage Intacct based on data from an import file or bank feed. When you receive a payment, you have the option to create an advance, these templates determine how to create the advance.

For more information, read create an AR advance transaction template in the Sage Intacct Help Center.

List AR advance transaction templates

get/objects/cash-management/ar-advance-txn-template

Returns a collection with a key, ID, and link for each AR advance transaction template. 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": "7",
      • "id": "ar-advance-tmp-02",
      • "href": "/objects/cash-management/ar-advance-txn-template/7"
      },
    • {
      • "key": "12",
      • "id": "ar-advance-tmp-03",
      • "href": "/objects/cash-management/ar-advance-txn-template/12"
      },
    • {
      • "key": "13",
      • "id": "ar-advance-tmp-04",
      • "href": "/objects/cash-management/ar-advance-txn-template/13"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}
Create an AR advance transaction template
post/objects/cash-management/ar-advance-txn-template
Creates a new AR advance transaction template.


SecurityOAuth2 
Request 
Request Body schema: application/json
required
id
required
string
Unique identifier for the AR advance transaction template.


 
 Example:  "AR-CUST-DEPOSIT-TMPL-03"
name
required
string
Name of the AR advance transaction template.


 
 Example:  "AR Customer Deposit Template 03"
description
string
Description of the AR advance transaction template.


 
 Example:  "AR Customer Deposit - Standard"
txnSource
string
Indicates how the AR transaction was created, such as manually or through an import.


 
 Example:  "CSV Import"
Array of objects
 
 Array 
required
object
General Ledger (GL) account for the AR advance transaction line item.


 
memo
string
Memo.


 
 Example:  "Customer prepayment for conference equipment."
accountLabel
string
Account label for the GL account.


 
 Example:  "Customer Deposits"
object
 
object
AR advance transaction template that contains this AR advance transaction template line.


 
status
string
 Default:  "active"
Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced.


 Enum: "active" "inactive"  
 Example:  "active"
status
string
 Default:  "active"
Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced.


 Enum: "active" "inactive"  
 Example:  "active"
Responses 
201
Created template


400
Bad Request


Request samples 
application/json
{
  • "id": "AR-CUST-DEPOSIT-TMPL-03",
  • "name": "AR Customer Deposit Template 03",
  • "description": "AR Customer Deposit - Standard",
  • "lines": [
    • {
      • "memo": "Standard AR transaction template for customer deposits",
      • "glAccount": {
        },
      • "dimensions": {
        }
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "12",
    • "id": "AR-CUST-DEPOSIT-TMPL-03",
    • "href": "/objects/cash-management/ar-advance-txn-template/12"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Get an AR advance transaction template
get/objects/cash-management/ar-advance-txn-template/{key}
Returns detailed information for a specified AR advance transaction template.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the AR advance transaction template.


 
 Example:  134
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "key": "13",
    • "id": "AR-PROJ-BILL-04",
    • "name": "AR Advance Project Billing Template - 04",
    • "txnSource": "CSV Import",
    • "description": "AR Project Billing",
    • "status": "active",
    • "audit": {
      • "createdDateTime": "2025-04-29T15:26:00Z",
      • "modifiedDateTime": "2025-04-29T15:26:00Z",
      • "createdByUser": {
        },
      • "createdBy": "159",
      • "modifiedByUser": {
        },
      • "modifiedBy": "159"
      },
    • "entity": {
      • "key": "46",
      • "id": "Western Region",
      • "name": "Western Region",
      • "href": "/objects/company-config/entity/46"
      },
    • "lines": [
      • {
        }
      ],
    • "href": "/objects/cash-management/ar-advance-txn-template/13"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Update an AR advance transaction template
patch/objects/cash-management/ar-advance-txn-template/{key}
Updates an existing AR advance transaction template by setting field values. Any fields not provided remain unchanged.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the AR advance transaction template.


 
 Example:  134
Request Body schema: application/json
name
string
Name of the AR advance transaction template.


 
 Example:  "AR Customer Deposit Template 03"
description
string
Description of the AR advance transaction template.


 
 Example:  "AR Customer Deposit - Standard"
txnSource
string
Indicates how the AR transaction was created, such as manually or through an import.


 
 Example:  "CSV Import"
Array of objects
 
 Array 
memo
string
Memo.


 
 Example:  "Customer prepayment for conference equipment."
object
General Ledger (GL) account for the AR advance transaction line item.


 
accountLabel
string
Account label for the GL account.


 
 Example:  "Customer Deposits"
object
 
object
AR advance transaction template that contains this AR advance transaction template line.


 
status
string
 Default:  "active"
Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced.


 Enum: "active" "inactive"  
 Example:  "active"
status
string
 Default:  "active"
Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced.


 Enum: "active" "inactive"  
 Example:  "active"
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "key": "12",
  • "name": "AR-CUST-DEPOSIT-HIGH-VOL-03",
  • "description": "AR Customer Deposit - High Volume Clients 03",
  • "lines": [
    • {
      • "key": "8",
      • "glAccount": {
        },
      • "memo": "AR transaction template for customer deposits - high volume clients",
      • "dimensions": {
        }
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "12",
    • "id": "AR-CUST-DEPOSIT-HIGH-VOL-03",
    • "href": "/objects/cash-management/ar-advance-txn-template/12"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Delete an AR advance transaction template
delete/objects/cash-management/ar-advance-txn-template/{key}
Deletes an AR advance transaction template.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the AR advance transaction template.


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