Document sequence rollovers

The document sequence rollover configuration holds the next number or alpha values used to generate sequences for each fiscal year. When rollover is enabled for a document sequence, a restart of the document sequence is initiated for each fiscal year.

If the configuration for a fiscal year is missing, it is automatically generated by the system when the first sequence is generated. When the system generates a configuration, the next number or alpha values from the base start values are used.

List document sequence rollovers

get/objects/company-config/document-sequence-rollover

Returns a collection with a key, ID, and link for each document sequence rollover object.

SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "651",
      • "id": "651",
      • "href": "/objects/company-config/document-sequence-rollover/651"
      },
    • {
      • "key": "652",
      • "id": "652",
      • "href": "/objects/company-config/document-sequence-rollover/652"
      }
    ],
  • "ia::meta": {
    • "totalCount": 2,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}
Get a document sequence rollover
get/objects/company-config/document-sequence-rollover/{key}
Returns detailed information for a specified document sequence rollover object.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the document sequence rollover object.


 
 Example:  10
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "id": "651",
    • "key": "651",
    • "documentSequence": {
      • "key": "107",
      • "id": "BOA_ACH_BatchNo",
      • "href": "/objects/company-config/document-sequence/107"
      },
    • "fiscalYear": 2026,
    • "nextNumber": 2026,
    • "nextSequence": null,
    • "audit": {
      • "createdDateTime": "2024-02-14T12:55:25Z",
      • "modifiedDateTime": "2024-02-14T12:55:25Z",
      • "createdBy": "109",
      • "modifiedBy": "109"
      },
    • "href": "/objects/company-config/document-sequence-rollover/651"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Query document sequence rollovers
post/services/core/query
Use the query service to find document sequence rollovers that meet certain criteria and to specify the properties that are returned.


SecurityOAuth2 
Responses 
200
OK


Request samples