Recurring schedules

Use recurring schedules to specify how often and for how long you want recurring transactions to run. Recurring schedules are only used when a user converts a transaction by line item.

List recurring schedule

get/objects/order-entry/recurring-schedule

Returns a collection with a key, ID, and link for each recurring schedule.

SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "17",
      • "id": "Daily",
      • "href": "/objects/order-entry/recurring-schedule/17"
      },
    • {
      • "key": "19",
      • "id": "Monthly",
      • "href": "/objects/order-entry/recurring-schedule/19"
      },
    • {
      • "key": "20",
      • "id": "Biweekly",
      • "href": "/objects/order-entry/recurring-schedule/20"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}
Create a recurring schedule
post/objects/order-entry/recurring-schedule
Creates a new recurring schedule.


SecurityOAuth2 
Request 
Request Body schema: application/json
required
id
required
string  <= 40 characters 
Enter a brief identifier for the recurring schedule.


 
 Example:  "Daily"
startDateType
required
string
 Default:  "transactionDate"
The start date drives both the start of the recurring schedule and when the schedule is repeated, unless you select End of month. For example, if the start date is on the 15th day of a month, the schedule will repeat on the 15th day of the month if the recurring schedule is set to repeat every month. If the recurring schedule is set to repeat every week, the schedule will repeat every 7 days, starting on the 15th day of the month. - Transaction date - The date in the Transaction date field on the transaction from which the line item is being converted. - User specified   - The date the user enters in the 'Schedule Start Date' field in the transaction's 'Line Item Entries Details' section (in the Sage Intacct UI), which follows this schedule on the sales transaction for the line item being converted.


 Enum: "transactionDate" "userSpecified"  
 Example:  "transactionDate"
repeatBy
required
string
 Default:  "days"
The time period at which the transaction should recur. For example, to establish a weekly schedule, set repeatBy to weekly and the repeatInterval to 1. You should set repeatBy to "none" if you want the schedule to occur only once on a specific date.


 Enum: "days" "endOfMonth" "months" "none" "weeks" "years"  
 Example:  "none"
repeatInterval
required
integer  <= 5 characters 
Enter the number of intervals for the selected time period. For example- If you want the schedule should repeat every other week, select 'repeatBy' to Weeks and enter 2 for this field. If you want the schedule to repeat at the end of each month, select 'repeatBy' to endOfMonth and enter 1 for this field.


 
 Example:  1
description
string  <= 100 characters 
Enter a meaningful description of the recurring schedule.


 
 Example:  "Daily schedule"
enableInstallmentPricing
boolean
 Default:  false
Enable this field if you want the system to divide the line item sales price by the number of times the transaction will repeat and create each transaction in the schedule with an installment price. For example, if the line item price is $1,200 and you specify After 12 occurrences, the system will create 12 transactions of $100 each. Leave this field blank if you want the system to use the full line item price for each scheduled transaction.


 
 Example:  false
endDate
string <date> 
Expiration date of the schedule on which the recurring schedule is to stop running.


 
 Example:  "2025-12-31"
repeatCount
integer
The maximum number of times the scheduler should be executed.


 
 Example:  1
object
The user who created the schedule.


 
key
string
System-assigned key for the userinfo.


 
 Example:  "1"
id
string
Unique login id given to user for login.


 
 Example:  "Admin"
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": "Daily",
  • "description": "Daily schedule",
  • "repeatBy": "days",
  • "repeatInterval": 1,
  • "startDateType": "transactionDate"
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "17",
    • "id": "Daily",
    • "href": "/objects/order-entry/recurring-schedule/17"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Get a recurring schedule
get/objects/order-entry/recurring-schedule/{key}
Returns detailed information for a specified recurring schedule.


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


 
 Example:  17
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "key": "17",
    • "id": "Daily",
    • "description": "Daily schedule",
    • "createdByUser": {
      • "key": "1",
      • "id": "Admin",
      • "href": "/objects/company-config/user/1"
      },
    • "repeatBy": "days",
    • "repeatInterval": 1,
    • "startDateType": "transactionDate",
    • "status": "active",
    • "enableInstallmentPricing": false,
    • "endDate": null,
    • "repeatCount": null,
    • "audit": {
      • "createdDateTime": "2024-05-15T16:46:11Z",
      • "modifiedDateTime": "2024-05-15T16:46:11Z",
      • "createdBy": "1",
      • "modifiedBy": "1"
      },
    • "href": "/objects/order-entry/recurring-schedule/17"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Update a recurring schedule
patch/objects/order-entry/recurring-schedule/{key}
Updates an existing recurring schedule by setting field values. Any fields not provided remain unchanged.


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


 
 Example:  17
Request Body schema: application/json
description
string  <= 100 characters 
Enter a meaningful description of the recurring schedule.


 
 Example:  "Daily schedule"
enableInstallmentPricing
boolean
 Default:  false
Enable this field if you want the system to divide the line item sales price by the number of times the transaction will repeat and create each transaction in the schedule with an installment price. For example, if the line item price is $1,200 and you specify After 12 occurrences, the system will create 12 transactions of $100 each. Leave this field blank if you want the system to use the full line item price for each scheduled transaction.


 
 Example:  false
endDate
string <date> 
Expiration date of the schedule on which the recurring schedule is to stop running.


 
 Example:  "2025-12-31"
repeatBy
string
 Default:  "days"
The time period at which the transaction should recur. For example, to establish a weekly schedule, set repeatBy to weekly and the repeatInterval to 1. You should set repeatBy to "none" if you want the schedule to occur only once on a specific date.


 Enum: "days" "endOfMonth" "months" "none" "weeks" "years"  
 Example:  "none"
repeatInterval
integer  <= 5 characters 
Enter the number of intervals for the selected time period. For example- If you want the schedule should repeat every other week, select 'repeatBy' to Weeks and enter 2 for this field. If you want the schedule to repeat at the end of each month, select 'repeatBy' to endOfMonth and enter 1 for this field.


 
 Example:  1
repeatCount
integer
The maximum number of times the scheduler should be executed.


 
 Example:  1
startDateType
string
 Default:  "transactionDate"
The start date drives both the start of the recurring schedule and when the schedule is repeated, unless you select End of month. For example, if the start date is on the 15th day of a month, the schedule will repeat on the 15th day of the month if the recurring schedule is set to repeat every month. If the recurring schedule is set to repeat every week, the schedule will repeat every 7 days, starting on the 15th day of the month. - Transaction date - The date in the Transaction date field on the transaction from which the line item is being converted. - User specified   - The date the user enters in the 'Schedule Start Date' field in the transaction's 'Line Item Entries Details' section (in the Sage Intacct UI), which follows this schedule on the sales transaction for the line item being converted.


 Enum: "transactionDate" "userSpecified"  
 Example:  "transactionDate"
object
The user who created the schedule.


 
key
string
System-assigned key for the userinfo.


 
 Example:  "1"
id
string
Unique login id given to user for login.


 
 Example:  "Admin"
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
{
  • "startDateType": "userSpecified",
  • "repeatInterval": 2
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "17",
    • "id": "Daily",
    • "href": "/objects/order-entry/recurring-schedule/17"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Delete a recurring schedule
delete/objects/order-entry/recurring-schedule/{key}
Deletes a recurring schedule.


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


 
 Example:  17
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 schedules
post/services/core/query
Use the query service to find recurring schedules that meet certain criteria and to specify the properties that are returned.


SecurityOAuth2 
Responses 
200
OK


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
    }
}