Use document sequencing to generate new IDs automatically for common transactions and records, such as new customers, vendors, invoices, and more. For example, you can create a document sequence for invoices. This new sequence automatically creates a new ID, such as 'INV-0100' and increments the number each time a new invoice is created.
Returns up to 100 document sequences from the collection with a key, ID, and link for each sequence. This operation is mostly for use in testing; use the query service to find document sequences that meet certain criteria and to specify the properties that are returned.
OK
Bad Request
{- "ia::result": [
- {
- "key": "37",
- "id": "BOA_ACH_BatchNo",
- "href": "/objects/company-config/document-sequence/37"
}, - {
- "key": "27",
- "id": "Purchase Order",
- "href": "/objects/company-config/document-sequence/27"
}
], - "ia::meta": {
- "totalCount": 2,
- "start": 1,
- "pageSize": 100,
- "next": null,
- "previous": null
}
}
Creates a new document sequence.
Document sequence to create
id required | string Document sequence ID Example: "Vendors" | ||||||||||||||||||
printTitle | string Print title Example: "Vendors" | ||||||||||||||||||
type | string Default: "numeric" Numeric or alpha sequence. Alpha sequences are currently only available for use with Cash Management, or French companies. Example: "numeric" | ||||||||||||||||||
fixedLength | string Fixed length, up to 16 characters (numeric sequence will be padded with zeros and alpha sequence will be padded with a's) Example: "16" | ||||||||||||||||||
fixedPrefix | string Fixed prefix Example: "INV" | ||||||||||||||||||
prefixSeparator | string Prefix separator Example: "-" | ||||||||||||||||||
fixedSuffix | string Fixed suffix Example: "COMPANY" | ||||||||||||||||||
suffixSeparator | string Suffix separator Example: "-" | ||||||||||||||||||
startingNumber | integer Starting number Example: 1 | ||||||||||||||||||
endingNumber | integer Ending number Example: 100 | ||||||||||||||||||
nextNumber | integer Next number Example: 1 | ||||||||||||||||||
startingSequence | string Starting sequence Example: "a" | ||||||||||||||||||
endingSequence | string Ending sequence Example: "zzz" | ||||||||||||||||||
nextSequence | string Next sequence Example: "a" | ||||||||||||||||||
whenModified | string <date-time> When updated Example: "2014-01-08T11:28:12Z" | ||||||||||||||||||
object Use the roollover configuration to generate IDs for documents meant to take effect in a specific fiscal year. | |||||||||||||||||||
| |||||||||||||||||||
status | string Default: "active" Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced. Example: "active" |
Created
Bad Request
{- "id": "Vendor Invoice",
- "printTitle": "Vendor Invoice",
- "type": "numeric",
- "fixedPrefix": "P",
- "fixedSuffix": "S",
- "prefixSeparator": "-",
- "suffixSeparator": "-",
- "startingNumber": 1,
- "endingNumber": null,
- "nextNumber": 1,
- "fixedLength": "4",
- "rollover": {
- "isEnabled": true,
- "fiscalYearAffixPosition": "prefix",
- "separator": "-",
- "fiscalYears": [
- {
- "fiscalYear": 2025,
- "nextNumber": 2025
}, - {
- "fiscalYear": 2026,
- "nextNumber": 2026
}
]
}
}
{- "ia::result": {
- "key": "107",
- "id": "Vendor Invoice",
- "href": "/objects/company-config/document-sequence/107"
}, - "ia::meta": {
- "totalCount": 1,
- "totalSuccess": 1,
- "totalError": 0
}
}
Returns detailed information for a particular document sequence.
key required | string System-assigned key for the document sequence. |
OK
Bad Request
{- "ia::result": {
- "key": "107",
- "id": "BOA_ACH_BatchNo",
- "printTitle": "BOA_ACH_BatchNo",
- "fixedPrefix": "P",
- "fixedSuffix": "S",
- "prefixSeparator": "-",
- "suffixSeparator": "-",
- "startingNumber": 1,
- "endingNumber": null,
- "nextNumber": 1,
- "whenModified": "2014-01-08T11:28:12Z",
- "fixedLength": null,
- "status": "active",
- "type": "numeric",
- "startingSequence": null,
- "endingSequence": null,
- "nextSequence": null,
- "rollover": {
- "isEnabled": true,
- "enabledDate": "2024-02-14",
- "fiscalYearAffixPosition": "prefix",
- "separator": "-"
}, - "audit": {
- "createdDateTime": "2014-01-08T11:28:12Z",
- "modifiedDateTime": "2014-01-08T11:28:12Z",
- "createdBy": "109",
- "modifiedBy": "109"
}, - "fiscalYears": [
- {
- "id": "646",
- "key": "646",
- "documentSequence": {
- "key": "405"
}, - "fiscalYear": 2026,
- "nextNumber": 2026,
- "nextSequence": null,
- "audit": {
- "createdDateTime": "2024-02-14T12:34:02Z",
- "modifiedDateTime": "2024-02-14T12:34:02Z",
- "createdBy": "109",
- "modifiedBy": "109"
}
}, - {
- "id": "645",
- "key": "645",
- "documentSequence": {
- "key": "405"
}, - "fiscalYear": 2025,
- "nextNumber": 2025,
- "nextSequence": null,
- "audit": {
- "createdDateTime": "2024-02-14T12:34:02Z",
- "modifiedDateTime": "2024-02-14T12:34:02Z",
- "createdBy": "109",
- "modifiedBy": "109"
}
}
], - "href": "/objects/company-config/document-sequence/107"
}, - "ia::meta": {
- "totalCount": 1,
- "totalSuccess": 1,
- "totalError": 0
}
}
Updates an existing document sequence by setting field values. Any fields not provided remain unchanged.
key required | string System-assigned key for the document sequence. |
printTitle | string Print title Example: "Vendors" | ||||||||||||||||||
type | string Default: "numeric" Numeric or alpha sequence. Alpha sequences are currently only available for use with Cash Management, or French companies. Example: "numeric" | ||||||||||||||||||
fixedLength | string Fixed length, up to 16 characters (numeric sequence will be padded with zeros and alpha sequence will be padded with a's) Example: "16" | ||||||||||||||||||
fixedPrefix | string Fixed prefix Example: "INV" | ||||||||||||||||||
prefixSeparator | string Prefix separator Example: "-" | ||||||||||||||||||
fixedSuffix | string Fixed suffix Example: "COMPANY" | ||||||||||||||||||
suffixSeparator | string Suffix separator Example: "-" | ||||||||||||||||||
startingNumber | integer Starting number Example: 1 | ||||||||||||||||||
endingNumber | integer Ending number Example: 100 | ||||||||||||||||||
nextNumber | integer Next number Example: 1 | ||||||||||||||||||
startingSequence | string Starting sequence Example: "a" | ||||||||||||||||||
endingSequence | string Ending sequence Example: "zzz" | ||||||||||||||||||
nextSequence | string Next sequence Example: "a" | ||||||||||||||||||
whenModified | string <date-time> When updated Example: "2014-01-08T11:28:12Z" | ||||||||||||||||||
object Use the roollover configuration to generate IDs for documents meant to take effect in a specific fiscal year. | |||||||||||||||||||
| |||||||||||||||||||
status | string Default: "active" Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced. Example: "active" |
OK
Bad Request
{- "prefixSeparator": "-"
}
{- "ia::result": {
- "key": "107",
- "id": "BOA_ACH_BatchNo",
- "href": "/objects/company-config/document-sequence/107"
}, - "ia::meta": {
- "totalCount": 1,
- "totalSuccess": 1,
- "totalError": 0
}
}
Deletes a document sequence.
key required | string System-assigned key for the document sequence. |
No Content
Bad Request
{- "ia::result": {
- "ia::error": {
- "code": "invalidRequest",
- "message": "Payload contains errors",
- "supportId": "sQrM9%7EYdh5oDEWVb80mrn9xuHjoAAAABBQ",
- "errorId": "REST-1064",
- "additionalInfo": {
- "messageId": "IA.PAYLOAD_CONTAINS_ERRORS",
- "placeholders": { },
- "propertySet": { }
}, - "details": [
- {
- "code": "invalidRequest",
- "message": "/testDate is not a valid field",
- "errorId": "REST-1043",
- "target": "/testDate",
- "additionalInfo": {
- "messageId": "IA.NOT_A_VALID_FIELD",
- "placeholders": {
- "FIELD": "/testDate"
}, - "propertySet": { }
}
}
]
}, - "ia::meta": {
- "totalCount": 3,
- "totalSuccess": 2,
- "totalError": 1
}
}, - "ia::error": {
- "code": "invalidRequest",
- "message": "Malformed URL",
- "supportId": "sQrM9%7EYdh5oDEWVb80mrn9xuHjoAAAABBQ",
- "details": [
- {
- "code": "invalidRequest",
- "message": "The content type is not valid",
- "correction": "TODO"
}
]
}
}
Queries an object for filtered data.
object | string Object type to query, in the form Example: "company-config/document-sequence" | ||||||||
fields | Array of strings List of fields to include in the response. Can be any combination of these:
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 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
These are most useful for queries that you want to save and use repeatedly, such as for views or reports. Just change the For example,
| |||||||||
filterExpression | string Default: "and" Logical operators to apply when there are multiple filter conditions. The conditions in the Shortcuts:
Example: "(1 and 2) or 3" | ||||||||
| |||||||||
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
| |||||||||
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 |
OK
Bad Request
{- "object": "company-config/document-sequence",
- "filters": [
- {
- "$eq": {
- "type": "numeric"
}
}
], - "fields": [
- "key",
- "id",
- "nextNumber",
- "href"
], - "orderBy": [
- {
- "id": "asc"
}
]
}
{- "ia::result": [
- {
- "key": "11",
- "id": "ACH Batch No.",
- "nextNumber": 1,
- "href": "/objects/company-config/document-sequence/11"
}, - {
- "key": "6",
- "id": "ActivationNo",
- "nextNumber": 654,
- "href": "/objects/company-config/document-sequence/6"
}, - {
- "key": "18",
- "id": "Adjustment Decrease",
- "nextNumber": 6,
- "href": "/objects/company-config/document-sequence/18"
}, - {
- "key": "19",
- "id": "Adjustment Increase",
- "nextNumber": 22,
- "href": "/objects/company-config/document-sequence/19"
}
], - "ia::meta": {
- "totalCount": 4,
- "start": 1,
- "pageSize": 100,
- "next": null,
- "previous": null
}
}