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 Recurring bills in the Sage Intacct Help Center.

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 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": "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. Recurring bills automate the billing process for regularly-recurring, fixed-amount bills, such as monthly rent. Sage 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.


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


 
 Example:  "Recurring Bill for 2025-01-23 services"
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 a contract associated with the recurring bill.


 
key
string or null
Unique key for the contract.


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


 
 Example:  "CON-2"
billNumber
string
 Deprecated 
Each occurrence of the bill is numbered incrementally based on the sequence type defined in Company Setup - Document Sequence.


 
 Example:  "AP-ADJ"
billSequenceNumber
string
Specify the initial value for the bill number, which will be incremented for each bill based on the sequence type defined in Company Setup - Document Sequence. For example, if you specify AP-ADJ in this field, the number for each recurring bill will start with AP-ADJ and will be incremented based on the sequence type. For example, AP-ADJ001, APAP-ADJ002, APAP-ADJ003, etc.


 
 Example:  "AP-ADJ"
object
Currency details for this recurring bill.


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


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


 
 Example:  "USD"
object
Exchange rate information for the recurring bill.


 
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:  "2025-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"
isTaxInclusive
boolean
 Default:  false
Set to true if bill amounts already include taxes.


 
 Example:  false
object
Supporting document attached to the bill.


 
key
string or null
System-assigned key for the supporting document.


 
 Example:  "18"
id
string or null
System-assigned ID for the supporting document.


 
 Example:  "18"
object
Tax solution details for the bill.


 
key
string or null
Unique key for the tax solution.


 
 Example:  "4"
id
string or null
Unique ID for the tax solution.


 
 Example:  "Australia GST"
object
Contacts for the recurring bill.


 
object
The vendor contact to be paid.


 
key
string
Unique key for the contact.


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


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


 
key
string
Unique key for the contact.


 
 Example:  "341"
id
string
Unique ID for the contact.


 
 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. This date remains editable until the first bill is processed.


 
 Example:  "2025-01-01"
repeatInterval
required
string
 Default:  "1"
Specifies the interval at which the bill repeats. This field works in conjunction with the repeatBy field, where you specify the regular interval at which the recurring bill should repeat. For example, if you set repeatBy to months and set the repeatInterval to 3, the schedule will run every 3 months.


 
 Example:  "1"
repeatBy
required
string
 Default:  "days"
Specifies the regular interval at which the recurring bill should repeat. This field 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"
endDate
string <date> 
Specify the end date for generating the recurring bill. A repeatCount can be specified instead of an endDate, but not both.


 
 Example:  "2026-01-01"
repeatCount
string
Specifies the number of times the recurring bill should be generated. Either this field or the endDate field must be specified to define the end condition for the recurring bill, not both.


 
 Example:  "50"
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
Unique key for the payment term.


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


 
id
required
string
Unique ID for the vendor.


 
 Example:  "Vendor_01"
key
string
Unique key for the vendor.


 
 Example:  "15"
Array of objects
Line items of the recurring bill.


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


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


 
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.


 
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.


 
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.


 
object
Label of the AP account to assign the expense to.


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


 
Array of objects
For companies subscribed to the Taxes application, tax entries for the recurring bill 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


400
Bad Request


Request samples 
application/json
{
  • "description": "DNO Recurring Bill 001",
  • "schedule": {
    • "startDate": "2025-03-21",
    • "repeatBy": "days",
    • "repeatInterval": "1",
    • "endDate": "2025-03-29"
    },
  • "term": {
    • "id": "N15"
    },
  • "referenceNumber": "DNO Recur bill",
  • "status": "active",
  • "contract": {
    • "id": "128",
    • "description": "DNO contract"
    },
  • "vendor": {
    • "id": "1099 Int"
    },
  • "currency": {
    • "baseCurrency": "USD",
    • "txnCurrency": "USD",
    • "exchangeRate": {
      • "date": "2024-02-21",
      • "typeId": "Intacct Daily Rate",
      • "rate": 1.0679
      }
    },
  • "lines": [
    • {
      • "memo": "DNO Recurring Bill line 01",
      • "glAccount": {
        },
      • "baseAmount": "120",
      • "hasForm1099": "false",
      • "currency": {
        },
      • "txnAmount": "150"
      },
    • {
      • "memo": "DNO Recurring Bill line 02",
      • "glAccount": {
        },
      • "baseAmount": "110",
      • "hasForm1099": "false",
      • "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.


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


 
 Example:  13
Responses 
200
Get a recurring bill


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "key": "12",
    • "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/12"
    },
  • "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.


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


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


 
 Example:  "Recurring Bill for 2025-01-23 services"
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 a contract associated with the recurring bill.


 
key
string or null
Unique key for the contract.


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


 
 Example:  "CON-2"
billNumber
string
 Deprecated 
Each occurrence of the bill is numbered incrementally based on the sequence type defined in Company Setup - Document Sequence.


 
 Example:  "AP-ADJ"
billSequenceNumber
string
Specify the initial value for the bill number, which will be incremented for each bill based on the sequence type defined in Company Setup - Document Sequence. For example, if you specify AP-ADJ in this field, the number for each recurring bill will start with AP-ADJ and will be incremented based on the sequence type. For example, AP-ADJ001, APAP-ADJ002, APAP-ADJ003, etc.


 
 Example:  "AP-ADJ"
object
Currency details for this recurring bill.


 
baseCurrency
string
Base currency for the company.


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


 
 Example:  "USD"
object
Exchange rate information for the recurring bill.


 
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:  "2025-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"
isTaxInclusive
boolean
 Default:  false
Set to true if bill amounts already include taxes.


 
 Example:  false
object
Supporting document attached to the bill.


 
key
string or null
System-assigned key for the supporting document.


 
 Example:  "18"
id
string or null
System-assigned ID for the supporting document.


 
 Example:  "18"
object
Tax solution details for the bill.


 
key
string or null
Unique key for the tax solution.


 
 Example:  "4"
id
string or null
Unique ID for the tax solution.


 
 Example:  "Australia GST"
object
Contacts for the recurring bill.


 
object
The vendor contact to be paid.


 
key
string
Unique key for the contact.


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


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


 
key
string
Unique key for the contact.


 
 Example:  "341"
id
string
Unique ID for the contact.


 
 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. This date remains editable until the first bill is processed.


 
 Example:  "2025-01-01"
endDate
string <date> 
Specify the end date for generating the recurring bill. A repeatCount can be specified instead of an endDate, but not both.


 
 Example:  "2026-01-01"
repeatCount
string
Specifies the number of times the recurring bill should be generated. Either this field or the endDate field must be specified to define the end condition for the recurring bill, not both.


 
 Example:  "50"
repeatBy
string
 Default:  "days"
Specifies the regular interval at which the recurring bill should repeat. This field 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"
Specifies the interval at which the bill repeats. This field works in conjunction with the repeatBy field, where you specify the regular interval at which the recurring bill should repeat. For example, if you set repeatBy to months and set the repeatInterval to 3, the schedule will run every 3 months.


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


 
key
string or null
Unique 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 ID for the vendor.


 
 Example:  "Vendor_01"
key
string
Unique key for the vendor.


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


 
object
Currency details for the recurring bill line.


 
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.


 
object
Label of the AP account to assign the expense to.


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


 
Array of objects
For companies subscribed to the Taxes application, tax entries for the recurring bill 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
{
  • "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.


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


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