Recurring bills

An AP recurring bill provides the ability to schedule and automate the process of creating AP bills. It is commonly used for regularly-recurring, fixed-amount bills. For more information, refer to the Sage Intacct Help Center.

Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.

List recurring bills

get/objects/accounts-payable/recurring-bill

Returns a collection with a key, ID, and link for each recurring bill. 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 bills
SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "1",
      • "id": "Adjustment Increase",
      • "href": "/objects/accounts-payable/recurring-bill/1"
      },
    • {
      • "key": "2",
      • "id": "Adjustment Increase",
      • "href": "/objects/accounts-payable/recurring-bill/2"
      },
    • {
      • "key": "3",
      • "id": "Bill",
      • "href": "/objects/accounts-payable/recurring-bill/3"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}
Create a recurring bill
post/objects/accounts-payable/recurring-bill
Creates a new recurring bill. This allows you to automate the billing process for regularly-recurring, fixed-amount bills, such as monthly rent. Intacct supports non-standard recurring transaction schedules and automatically enters and posts bills based on the defined schedule. The transaction and GL posting date for an automatically generated bill are the same, but you can change either.


    

  • If your organization uses multiple base currencies, create recurring bills at the entity level.
    • 

  • Recurring bills do not support custom fields or custom fields defined in a bill. If you need to use a custom field in a recurring bill, configure the custom field as not required.
    • 




Permissions and other requirements



SubscriptionAccounts Payable


User typeBusiness


PermissionsList, View, Add Recurring bills







SecurityOAuth2 
Request 
Request Body schema: application/json
id
string or null
Unique identifier for the recurring bill.


 
 Example:  "1"
description
string or null
Additional information about the recurring bill.


 
 Example:  "Recurring Bill created on date 2021-01-23"
referenceNumber
string or null
A reference number, such as a purchase order or account number, used for searches and reports. This number appears on the general ledger details report and prints on checks and vendor stubs.


 
 Example:  "RecurBill-100"
object
Represents the contract associated with the recurring bill.


 
key
string or null
System-assigned key for the contract.


 
 Example:  "2"
id
string or null
Unique identifier for the contract.


 
 Example:  "CON-2"
description
string or null
Description of the contract.


 
 Example:  "CON-2"
txnTotalEntered
string <decimal-precision-2> 
Total transaction amount.


 
 Example:  "100"
object
Currency details for this recurring bill.


 
txnCurrency
required
string
The transaction currency to use for this recurring bill. If this currency is different from the base currency, provide an exchange rate.


 
 Example:  "USD"
baseCurrency
string
Base currency for your company.


 
 Example:  "USD"
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
number or null
Exchange rate used to calculate the base amount from the transaction amount.


 
 Example:  1.0789
typeId
string or null
Exchange rate type used to calculate the base amount from the transaction amount.


 
 Example:  "1"
object
Contacts for this recurring bill.


 
object
The vendor contact to be paid.


 
key
string
System-assigned key for the contact.


 
 Example:  "916"
id
string
Unique identifier for the contact.


 
 Example:  "Power Aerospace Materials(C1)"
object
The vendor contact for return of the purchase.


 
key
string
System-assigned key for the contact for return of the purchase.


 
 Example:  "916"
id
string
Unique identifier for the contact for return of the purchase.


 
 Example:  "Power Aerospace Materials(C1)"
object
Defines the scheduling details for the recurring bill, including start date, frequency, next execution date, and end conditions. The schedule provides a comprehensive view of when and how often the recurring bill will be generated.


 
startDate
required
string <date> 
Specifies the initial date for generating the recurring bill. It remains editable until the first bill is processed.


 
 Example:  "2021-01-01"
repeatInterval
required
string
 Default:  "1"
The interval at which the bill repeats, based on the scheduler.


 
 Example:  "1"
endDate
string <date> 
End date for the scheduled execution of the recurring bill.


 
 Example:  "2022-01-01"
nextExecutionDate
string <date> 
Indicates the upcoming date for the next bill generation attempt. This field can be updated for existing schedules.


 
 Example:  "2021-02-01"
lastExecutionDate
string <date> 
Last date for the scheduled execution of the recurring bill.


 
 Example:  "2021-12-01"
recurringDueDate
string <date> 
Due date for the scheduled execution of the recurring bill.


 
 Example:  "2021-06-01"
frequency
string
The frequency at which the bill recurs. This interacts with the repeat interval.


 Enum: "days" "endOfMonth" "months" "none" "weeks" "years"  
 Example:  "days"
executionCount
string
Tracks the number of attempts to generate the recurring bill. This value reflects the number of times the system has tried to create the bill, which may differ from the number of successful transactions due to potential errors during execution.


 
 Example:  "100"
repeatCount
string
The number of times the recurring bill is set to repeat.


 
 Example:  "50"
repeatBy
string
 Default:  "days"
Specifies the regular interval at which the recurring bill should repeat. This setting works in conjunction with the repeatInterval field, where you specify the number of intervals. For example, if you set repeatBy to months and set the repeatInterval to 3, the schedule will run every 3 months.


 Enum: "days" "endOfMonth" "months" "none" "weeks" "years"  
 Example:  "days"
object
Payment terms, which are used to calculate due date, discounts, and penalties associated with this bill.


 
id
required
string or null
Name or other unique identifier for the payment term.


 
 Example:  "N15"
key
string or null
System-assigned key for the payment term.


 
 Example:  "3"
object
Vendor associated with the recurring bill.


 
id
required
string
Unique identifier for the vendor.


 
 Example:  "Vendor_01"
key
string
System-assigned key for the vendor.


 
 Example:  "15"
name
string
Name of the vendor.


 
 Example:  "Logic Solutions"
Array of objects
Line items of the Recurring bill.


 
 Array 
txnAmount
required
string <decimal-precision-2> 
Amount for the line item in the transaction currency.


 
 Example:  "100"
required
object
The name of the GL account that the line item is assigned to.


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


 
 Example:  "Service charges"
baseAmount
string <decimal-precision-2> 
For multi-currency companies, the transaction amount in the base currency.


 
 Example:  "100"
lineNumber
string
Line number of the line item.


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


 
isBillable
boolean
 Default:  false
Indicates whether the line item is marked as billable.


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


 
object
Transaction allocation template for the line item, which distributes the bill amount across specified dimensions.


 
object
Meaningful name of the AP account to assist with expense assignment.


 
object
 
object
Alternative GL account to the default GL account for the bill.


 
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


400
Bad Request


Request samples 
application/json
{
  • "id": "Invoice",
  • "description": "DNO Recurring Bill 001",
  • "schedule": {
    • "startDate": "2024-03-21",
    • "repeatBy": "days",
    • "repeatInterval": "1",
    • "endDate": "2024-03-29"
    },
  • "term": {
    • "id": "N15"
    },
  • "referenceNumber": "DNO Recurr bill",
  • "status": "active",
  • "contract": {
    • "id": "128",
    • "description": "DNO contract"
    },
  • "vendor": {
    • "id": "1099 Int"
    },
  • "currency": {
    • "baseCurrency": "USD",
    • "txnCurrency": "USD",
    • "exchangeRate": {
      • "date": "2022-02-21",
      • "typeId": "Intacct Daily Rate",
      • "rate": 1.0679
      }
    },
  • "lines": [
    • {
      • "memo": "DNO Recurring Bill line 01",
      • "glAccount": {
        },
      • "baseAmount": "150",
      • "dimensions": {
        },
      • "hasForm1099": false,
      • "accountLabel": {
        },
      • "currency": {
        },
      • "txnAmount": "120.00"
      },
    • {
      • "memo": "DNO Recurring Bill line 02",
      • "glAccount": {
        },
      • "baseAmount": "110",
      • "dimensions": {
        },
      • "hasForm1099": false,
      • "accountLabel": {
        },
      • "currency": {
        },
      • "txnAmount": "130.00"
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "5",
    • "id": "5",
    • "href": "/objects/accounts-payable/recurring-bill/5",
    • "ia::meta": {
      • "totalCount": 1
      }
    }
}
Get a recurring bill
get/objects/accounts-payable/recurring-bill/{key}
Returns detailed information for a specified recurring bill.



Permissions and other requirements



SubscriptionAccounts Payable


User typeBusiness


PermissionsList, View Recurring bills







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


 
Responses 
200
Reference to the recurring bill


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "key": "1",
    • "description": "DNO Recurring Bill",
    • "audit": {
      • "createdDateTime": "2024-03-20T00:00:00Z",
      • "modifiedDateTime": "2024-03-20T11:38:13Z",
      • "createdBy": "1",
      • "modifiedBy": "1"
      },
    • "term": {
      • "key": "8",
      • "id": "N15",
      • "href": "/objects/accounts-payable/term/8"
      },
    • "id": "Invoice",
    • "totalEntered": "337.02",
    • "referenceNumber": "DNO Recurr bill",
    • "moduleKey": "3.AP",
    • "status": "active",
    • "recurringSchedule": {
      • "id": "1",
      • "key": "1",
      • "href": "/objects/core/schedule/1"
      },
    • "contract": {
      • "id": "128",
      • "description": "DNO contract"
      },
    • "vendor": {
      • "id": "1099 Int",
      • "name": "1099 Int",
      • "key": "43",
      • "href": "/objects/accounts-payable/vendor/43"
      },
    • "currency": {
      • "txnCurrency": "USD",
      • "baseCurrency": "AUD"
      },
    • "txnTotalEntered": "220.00",
    • "lines": [
      • {
        },
      • {
        }
      ],
    • "href": "/objects/accounts-payable/recurring-bill/1"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Update a recurring bill
patch/objects/accounts-payable/recurring-bill/{key}
Updates an existing recurring bill by setting field values. Any fields not provided remain unchanged.



Permissions and other requirements



SubscriptionAccounts Payable


User typeBusiness


PermissionsList, Edit Recurring bills







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


 
Request Body schema: application/json
description
string or null
Additional information about the recurring bill.


 
 Example:  "Recurring Bill created on date 2021-01-23"
referenceNumber
string or null
A reference number, such as a purchase order or account number, used for searches and reports. This number appears on the general ledger details report and prints on checks and vendor stubs.


 
 Example:  "RecurBill-100"
object
Represents the contract associated with the recurring bill.


 
key
string or null
System-assigned key for the contract.


 
 Example:  "2"
id
string or null
Unique identifier for the contract.


 
 Example:  "CON-2"
description
string or null
Description of the contract.


 
 Example:  "CON-2"
txnTotalEntered
string <decimal-precision-2> 
Total transaction amount.


 
 Example:  "100"
object
Currency details for this recurring bill.


 
baseCurrency
string
Base currency for your company.


 
 Example:  "USD"
txnCurrency
string
The transaction currency to use for this recurring bill. If this currency is different from the base currency, provide an exchange rate.


 
 Example:  "USD"
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
number or null
Exchange rate used to calculate the base amount from the transaction amount.


 
 Example:  1.0789
typeId
string or null
Exchange rate type used to calculate the base amount from the transaction amount.


 
 Example:  "1"
object
Contacts for this recurring bill.


 
object
The vendor contact to be paid.


 
key
string
System-assigned key for the contact.


 
 Example:  "916"
id
string
Unique identifier for the contact.


 
 Example:  "Power Aerospace Materials(C1)"
object
The vendor contact for return of the purchase.


 
key
string
System-assigned key for the contact for return of the purchase.


 
 Example:  "916"
id
string
Unique identifier for the contact for return of the purchase.


 
 Example:  "Power Aerospace Materials(C1)"
object
Defines the scheduling details for the recurring bill, including start date, frequency, next execution date, and end conditions. The schedule provides a comprehensive view of when and how often the recurring bill will be generated.


 
startDate
string <date> 
Specifies the initial date for generating the recurring bill. It remains editable until the first bill is processed.


 
 Example:  "2021-01-01"
endDate
string <date> 
End date for the scheduled execution of the recurring bill.


 
 Example:  "2022-01-01"
nextExecutionDate
string <date> 
Indicates the upcoming date for the next bill generation attempt. This field can be updated for existing schedules.


 
 Example:  "2021-02-01"
lastExecutionDate
string <date> 
Last date for the scheduled execution of the recurring bill.


 
 Example:  "2021-12-01"
recurringDueDate
string <date> 
Due date for the scheduled execution of the recurring bill.


 
 Example:  "2021-06-01"
frequency
string
The frequency at which the bill recurs. This interacts with the repeat interval.


 Enum: "days" "endOfMonth" "months" "none" "weeks" "years"  
 Example:  "days"
executionCount
string
Tracks the number of attempts to generate the recurring bill. This value reflects the number of times the system has tried to create the bill, which may differ from the number of successful transactions due to potential errors during execution.


 
 Example:  "100"
repeatCount
string
The number of times the recurring bill is set to repeat.


 
 Example:  "50"
repeatBy
string
 Default:  "days"
Specifies the regular interval at which the recurring bill should repeat. This setting works in conjunction with the repeatInterval field, where you specify the number of intervals. For example, if you set repeatBy to months and set the repeatInterval to 3, the schedule will run every 3 months.


 Enum: "days" "endOfMonth" "months" "none" "weeks" "years"  
 Example:  "days"
repeatInterval
string
 Default:  "1"
The interval at which the bill repeats, based on the scheduler.


 
 Example:  "1"
object
Payment terms, which are used to calculate due date, discounts, and penalties associated with this bill.


 
key
string or null
System-assigned key for the payment term.


 
 Example:  "3"
id
string or null
Name or other unique identifier for the payment term.


 
 Example:  "N15"
object
Vendor associated with the recurring bill.


 
id
string
Unique identifier for the vendor.


 
 Example:  "Vendor_01"
key
string
System-assigned key for the vendor.


 
 Example:  "15"
name
string
Name of the vendor.


 
 Example:  "Logic Solutions"
Array of objects
Line items of the Recurring bill.


 
 Array 
memo
string or null
Memo that appears on the check stub and provides information about the line item.


 
 Example:  "Service charges"
baseAmount
string <decimal-precision-2> 
For multi-currency companies, the transaction amount in the base currency.


 
 Example:  "100"
lineNumber
string
Line number of the line item.


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


 
txnAmount
string <decimal-precision-2> 
Amount for the line item in the transaction currency.


 
 Example:  "100"
isBillable
boolean
 Default:  false
Indicates whether the line item is marked as billable.


 
 Example:  true
object
The name of the GL account that the line item is assigned to.


 
object
Currency details for the recurring bill line.


 
object
Transaction allocation template for the line item, which distributes the bill amount across specified dimensions.


 
object
Meaningful name of the AP account to assist with expense assignment.


 
object
 
object
Alternative GL account to the default GL account for the bill.


 
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
{
  • "description": "New payouts recurring bill"
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "5",
    • "id": "5",
    • "href": "/objects/accounts-payable/recurring-bill/5",
    • "ia::meta": {
      • "totalCount": 1,
      • "totalSuccess": 1,
      • "totalError": 0
      }
    }
}
Delete a recurring bill
delete/objects/accounts-payable/recurring-bill/{key}
Deletes a recurring bill specified by the given key.



Permissions and other requirements



SubscriptionAccounts Payable


User typeBusiness


PermissionsList, View, Delete Recurring bills







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


 
Responses 
204
No Content


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::error": {
    • "code": "invalidRequest",
    • "message": "Malformed URL",
    • "supportId": "sQrM9%7EYdh5oDEWVb80mrn9xuHjoAAAABBQ",
    • "details": [
      • {
        }
      ]
    }
}
Query recurring bills
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"
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 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 response.


 
 Example:  100
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "object": "accounts-payable/recurring-bill",
  • "filters": [
    • {
      • "$eq": {
        }
      }
    ],
  • "fields": [
    • "key",
    • "id",
    • "description",
    • "referenceNumber",
    • "totalEntered",
    • "createdDate",
    • "vendor.id",
    • "vendor.name"
    ],
  • "orderBy": [
    • {
      • "id": "asc"
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "23",
      • "id": "23",
      • "description": "Recurring Bill created on date 2021-01-23",
      • "referenceNumber": "RecurBill-100",
      • "totalEntered": "100.00",
      • "createdDate": "2021-01-23",
      • "vendor": {
        }
      },
    • {
      • "key": "24",
      • "id": "24",
      • "description": "Recurring Bill for March 2021",
      • "referenceNumber": "RecurBill-101",
      • "totalEntered": "150.00",
      • "createdDate": "2021-03-01",
      • "vendor": {
        }
      },
    • {
      • "key": "25",
      • "id": "25",
      • "description": "Recurring Bill for April 2021",
      • "referenceNumber": "RecurBill-102",
      • "totalEntered": "200.00",
      • "createdDate": "2021-04-01",
      • "vendor": {
        }
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}