Recurring bill lines

Line items in a recurring bill represent transactions captured in that recurring bill. For more information, see Recurring bills in the Sage Intacct Help Center.

List recurring bill lines

get/objects/accounts-payable/recurring-bill-line

Returns a collection with a key, ID, and link for each recurring bill line. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned.

Permissions and other requirements
SubscriptionAccounts Payable
User typeBusiness
PermissionsList, View Recurring bill lines
SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "1",
      • "id": "1",
      • "href": "/objects/accounts-payable/recurring-bill-line/1"
      },
    • {
      • "key": "4",
      • "id": "4",
      • "href": "/objects/accounts-payable/recurring-bill-line/4"
      },
    • {
      • "key": "7",
      • "id": "7",
      • "href": "/objects/accounts-payable/recurring-bill-line/7"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}
Create a recurring bill line
post/objects/accounts-payable/recurring-bill-line
Creates a new recurring bill line.



Permissions and other requirements



SubscriptionAccounts Payable


User typeBusiness


PermissionsList, View, Add Recurring bill lines







SecurityOAuth2 
Request 
Request Body schema: application/json
required
One of:
Line items in a recurring bill represent transactions captured in that recurring bill.


required
object
Transaction allocation template for the line item, which distributes the bill amount across specified dimensions. When creating a recurring bill line, you must include either an allocation in the request, or dimensions.


 
key
string or null
Unique key for the allocation template.


 
 Example:  "16"
id
string or null
Unique ID for the allocation template.


 
 Example:  "16"
txnAmount
required
string <decimal-precision-2> 
Amount of the line item in the transaction currency.


 
 Example:  "100"
required
object or object
 
One of:
GL account associated with the line item.


key
required
string
Unique key for the GL account.


 
 Example:  "220"
id
string
Unique ID for the GL account.


 
 Example:  "1501.04"
memo
string or null
Memo that appears on the check stub and provides information about the line item.


 
 Example:  "Service charges"
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
Type of 1099 form.


 
 Example:  "NEC"
box
string or null
Box number for form 1099.


 
 Example:  "15A"
totalTxnAmount
string <decimal-precision-2> 
For tax inclusive recurring bills, total transaction amount.


 
 Example:  "112.00"
isBillable
boolean
 Default:  false
Set to true if the line item will be billed to the customer.


 
 Example:  true
object
Currency details for the recurring bill line.


 
baseCurrency
string
Base currency for the company.


 
 Example:  "USD"
txnCurrency
string
Transaction currency for the recurring bill.


 
 Example:  "USD"
object
For multi-currency companies, the exchange rate for this line item.


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


 
 Example:  "2024-01-23"
rate
number
Exchange rate to use.


 
 Example:  1.0789
typeId
string
Exchange rate type to use, such as the Intacct Daily Rate.


 
 Example:  "INR-Rate"
object
Label of the AP account to assign the expense to.


 
key
string or null
Unique key for the account label.


 
 Example:  "14"
id
string or null
Unique ID for the account label.


 
 Example:  "Accounting Fees"
object
Dimensions associated with the line item. When creating a recurring bill line, you must include either an allocation in the request, or dimensions. A location is required if you include dimensions in the request.


 
object
Location to assign the expense to.


 
key
string or null
Location key


 
 Example:  "9"
id
string or null
Location ID


 
 Example:  "9"
object
Department to assign the expense to.


 
key
string or null
Department key


 
 Example:  "21"
id
string or null
Department ID


 
 Example:  "21"
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
An alternative account to override the default GL account for the bill.


 
key
string
Unique key for the GL account.


 
 Example:  "384"
id
string
Unique ID for the GL account.


 
 Example:  "1234.36"
Array of objects
For companies subscribed to the Taxes application, tax entries for the recurring bill line.


 
 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 entry tax details describe a specific type of tax that applies to lines in Accounts Payable transactions.


 
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


400
Bad Request


Request samples 
application/json
{
  • "recurringBill": {
    • "key": "1159"
    },
  • "txnAmount": "2500",
  • "glAccount": {
    • "key": "254"
    },
  • "dimensions": {
    • "location": {
      • "key": "1"
      },
    • "vendor": {
      • "id": "209"
      },
    • "department": {
      • "id": "77"
      },
    • "project": {
      • "key": "27"
      },
    • "customer": {
      • "id": "HC"
      }
    },
  • "memo": "server charges bill",
  • "overrideOffsetGLAccount": {
    • "key": "252"
    },
  • "hasForm1099": "true",
  • "form1099": {
    • "type": "NEC",
    • "box": "7"
    },
  • "accountLabel": {
    • "key": "28"
    }
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "5",
    • "id": "5",
    • "href": "/objects/accounts-payable/recurring-bill-line/5",
    • "ia::meta": {
      • "totalCount": 1
      }
    }
}
Get a recurring bill line
get/objects/accounts-payable/recurring-bill-line/{key}
Returns detailed information for a specified recurring bill line.



Permissions and other requirements



SubscriptionAccounts Payable


User typeBusiness


PermissionsList, View Recurring bill lines







SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the recurring bill line.


 
 Example:  15
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "id": "15",
    • "key": "15",
    • "recurringBill": {
      • "id": "32'",
      • "key": "32",
      • "href": "/objects/accounts-payable/recurring-bill/32"
      },
    • "memo": "DNO Recurring Bill",
    • "glAccount": {
      • "key": "246",
      • "id": "6000",
      • "name": "G&A Salaries",
      • "href": "/objects/general-ledger/account/246"
      },
    • "baseAmount": "183.83",
    • "dimensions": {
      • "location": {
        },
      • "department": {
        },
      • "project": {
        },
      • "customer": {
        },
      • "vendor": {
        },
      • "employee": {
        },
      • "item": {
        },
      • "class": {
        }
      },
    • "lineNumber": 0,
    • "hasForm1099": "false",
    • "form1099": {
      • "type": null,
      • "box": null
      },
    • "accountLabel": {
      • "id": null
      },
    • "currency": {
      • "txnCurrency": "USD",
      • "baseCurrency": "AUD"
      },
    • "txnAmount": "120.00",
    • "allocation": {
      • "id": null,
      • "key": null,
      • "name": null
      },
    • "isBillable": null,
    • "audit": {
      • "createdDateTime": "2024-03-20T11:38:13Z",
      • "modifiedDateTime": "2024-03-20T11:38:13Z",
      • "createdBy": "1",
      • "modifiedBy": "1"
      },
    • "href": "/objects/accounts-payable/recurring-bill-line/15"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Update a recurring bill line
patch/objects/accounts-payable/recurring-bill-line/{key}
Updates a recurring bill line.



Permissions and other requirements



SubscriptionAccounts Payable


User typeBusiness


PermissionsList, View, Edit Recurring bill lines







SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the recurring bill line.


 
 Example:  15
Request Body schema: application/json
required
memo
string or null
Memo that appears on the check stub and provides information about the line item.


 
 Example:  "Service charges"
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
Type of 1099 form.


 
 Example:  "NEC"
box
string or null
Box number for form 1099.


 
 Example:  "15A"
txnAmount
string <decimal-precision-2> 
Amount of the line item in the transaction currency.


 
 Example:  "100"
totalTxnAmount
string <decimal-precision-2> 
For tax inclusive recurring bills, total transaction amount.


 
 Example:  "112.00"
isBillable
boolean
 Default:  false
Set to true if the line item will be billed to the customer.


 
 Example:  true
object
GL account associated with the line item.


 
key
string
Unique key for the GL account.


 
 Example:  "220"
id
string
Unique ID for the GL account.


 
 Example:  "1501.04"
object
Currency details for the recurring bill line.


 
baseCurrency
string
Base currency for the company.


 
 Example:  "USD"
txnCurrency
string
Transaction currency for the recurring bill.


 
 Example:  "USD"
object
For multi-currency companies, the exchange rate for this line item.


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


 
 Example:  "2024-01-23"
rate
number
Exchange rate to use.


 
 Example:  1.0789
typeId
string
Exchange rate type to use, such as the Intacct Daily Rate.


 
 Example:  "INR-Rate"
object
Transaction allocation template for the line item, which distributes the bill amount across specified dimensions. When creating a recurring bill line, you must include either an allocation in the request, or dimensions.


 
key
string or null
Unique key for the allocation template.


 
 Example:  "16"
id
string or null
Unique ID for the allocation template.


 
 Example:  "16"
object
Label of the AP account to assign the expense to.


 
key
string or null
Unique key for the account label.


 
 Example:  "14"
id
string or null
Unique ID for the account label.


 
 Example:  "Accounting Fees"
object
Dimensions associated with the line item. When creating a recurring bill line, you must include either an allocation in the request, or dimensions. A location is required if you include dimensions in the request.


 
object
Location to assign the expense to.


 
key
string or null
Location key


 
 Example:  "9"
id
string or null
Location ID


 
 Example:  "9"
object
Department to assign the expense to.


 
key
string or null
Department key


 
 Example:  "21"
id
string or null
Department ID


 
 Example:  "21"
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
An alternative account to override the default GL account for the bill.


 
key
string
Unique key for the GL account.


 
 Example:  "384"
id
string
Unique ID for the GL account.


 
 Example:  "1234.36"
Array of objects
For companies subscribed to the Taxes application, tax entries for the recurring bill line.


 
 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 entry tax details describe a specific type of tax that applies to lines in Accounts Payable transactions.


 
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


400
Bad Request


Request samples 
application/json
{
  • "txnAmount": "2400",
  • "overrideOffsetGLAccount": {
    • "key": "254"
    }
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "5",
    • "id": "5",
    • "href": "/objects/accounts-payable/recurring-bill-line/5",
    • "ia::meta": {
      • "totalCount": 1
      }
    }
}
Delete recurring bill lines
delete/objects/accounts-payable/recurring-bill-line/{key}
Deletes a recurring bill line.



Permissions and other requirements



SubscriptionAccounts Payable


User typeBusiness


PermissionsList, View, Delete Recurring bill lines







SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the recurring bill line.


 
 Example:  15
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
    }
}
Query recurring bill lines
post/services/core/query
Queries an object for filtered data.


SecurityOAuth2 
Request 
Request Body schema: application/json
object
string
Object type to query, in the form <application-name>/<object name>. For custom objects use platform-apps/nsp::<object-name>.


 
 Example:  "accounts-payable/recurring-bill-line"
fields
Array of strings
List of fields to include in the response. Can be any combination of these:


    

  • The name of a field in the object that you are querying, such as id.
    

    • 

  • The name of a field in a related object, using the form relatedObjectName.fieldName, such as vendor.id.
    

    • 

  • The result of an aggregate function run against the values in the returned objects. Use the form function:fieldName, such as min:startDate to return the earliest starting date. Valid function names are:
    

      

    • count
      • 

    • avg
      • 

    • sum
      • 

    • min
      • 

    • max
      • 

    

    • 

  • The result of an aggregate function run against the values in related objects, using the form function:relatedObjectName.fieldName, such as max:vendor.creditLimit. The same functions are supported as for object fields.
    

    • 



 
 Example:  ["key","id","max:vendor.creditLimit"]
Array of equal (object) or not equal (object) or less than (object) or (less than or equal (object)) or greater than (object) or (greater than or equal (object)) or in (object) or not in (object) or between (object) or not between (object) or contains (object) or does not contain (object) or has (object) or starts with (object) or does not start with (object) or ends with (object) or does not end with (object)
Filter conditions to select the objects to return based on their field values. You use operators and conditions to build your filter, such as {"$eq":{"status":"active"}} to select objects in which status is equal to "active".


 
 Example:  [{"$eq":{"status":"active"}},{"$gt":{"totalDue":"1000"}},{"$contains":{"name":"Acme"}}]
 Array 
Any of:
Field value must be equal to this specified value.


For date fields, you can use these macro values that are relative to the current date or the asOfDate in filterParameters, if set:







    

  • today

  • currentWeek

  • currentMonth

  • currentQuarter

  • currentYear





    

  • yesterday

  • lastWeek

  • priorMonth

  • priorQuarter

  • priorYear









These are most useful for queries that you want to save and use repeatedly, such as for views or reports. Just change the asOfDate each time to retrieve the same data set for different time periods.


For example, {"eq":{"postingDate":"priorYear"}}.


object
The field name and value to be compared with object values.


 
 Example:  {"status":"active"}
filterExpression
string
 Default:  "and"
Logical operators to apply when there are multiple filter conditions. The conditions in the filters array are implicitly numbered starting at 1. Supports and, or, and grouping with parentheses.


Shortcuts:


    

  • and by itself means that all conditions must be true.
    • 

  • or by itself means that at least one condition must be true.
    • 



 
 Example:  "(1 and 2) or 3"
object

Pre-defined filter options.


 
asOfDate
string <date> 
The "as of" date to use with any relative date comparisons in filters. For example, if asOfDate is set to "2022-04-01" then priorMonth will be "03".


The current date is used if asOfDate is not set.


 
 Example:  "2022-04-01"
includeHierarchyFields
boolean
 Default:  false
Set to true to include hierarchical structure information with each object in the response.


 
 Example:  false
caseSensitiveComparison
boolean
 Default:  true
Queries are case-sensitive by default. Set to false to ignore case in a query.


 
 Example:  true
includePrivate
boolean
 Default:  false
By default, in a multi-entity company queries from the top-level entity do not access data in private entities. Set includePrivate to true if you want to query data in private entities.


 
 Example:  false
Array of objects
Set the order of the results by specifying field names to sort by and whether they should be in ascending or descending order.


 
 Example:  [{"totalDue":"asc"},{"lastPaymentMadeDate":"desc"}]
 Array 
property name*
additional property
string
 Enum: "asc" "desc"  
start
integer
First record of the result set to include in the response.


 
 Example:  1
size
integer
Number of records to include in the result set, 4000 maximum.


 
 Example:  100
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "object": "accounts-payable/recurring-bill-line",
  • "filters": [
    • {
      • "$eq": {
        }
      }
    ],
  • "fields": [
    • "key",
    • "id",
    • "glAccount.id",
    • "glAccount.name",
    • "baseAmount",
    • "txnAmount",
    • "memo"
    ],
  • "orderBy": [
    • {
      • "id": "asc"
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "23",
      • "id": "23",
      • "glAccount": {
        },
      • "baseAmount": "100.00",
      • "txnAmount": "120.00",
      • "memo": "Service charges"
      },
    • {
      • "key": "24",
      • "id": "24",
      • "glAccount": {
        },
      • "baseAmount": "150.00",
      • "txnAmount": "180.00",
      • "memo": "Monthly subscription"
      },
    • {
      • "key": "25",
      • "id": "25",
      • "glAccount": {
        },
      • "baseAmount": "200.00",
      • "txnAmount": "240.00",
      • "memo": "Annual fees"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}