Get next IDs for site

GET /api/configuration/system/sites/{id}/next-ids

Success: 200 OK

• Products: Operator (FOH)
• Features: Front of House Generic Access (FOHGENERIC)

Overview

Returns the 23 sequence counters a site uses to allocate its own record numbers — the next booking ID it will issue, the next member ID, the next invoice number and so on. Each counter is a system-configuration setting held against the site, and this endpoint reads them all in one call and returns them as integers.

This is a read, not an allocation. Calling it does not reserve a number or advance any counter, and two callers reading at the same moment see the same values. Do not use it to generate identifiers of your own — the platform advances these counters itself as records are created, and a number you read here will very likely be taken by the time you try to use it. Its legitimate uses are inspection and reconciliation: confirming a site has been provisioned, checking that counters are where a data migration left them, or reading current values before writing new ones with the matching PUT.

Two things catch integrators out:

• The call is all-or-nothing across all 23 counters. If even one of them is missing for that site, the whole request fails with 422 rather than returning the ones it found. A site provisioned through the create-site endpoint gets all 23 set up automatically, so this normally only bites on sites created by other means or partially migrated.
• The 422 and 500 responses have empty bodies. The reason is not returned to you, so you cannot tell from the response which counter was missing or malformed.

Note also that these counters are only meaningfully per-site when the operator has the Database_EnableSiteSpecificIDs configuration switched on. Reads always work regardless; it is the corresponding update that is rejected when the switch is off.

Endpoint

GET {base_url}/api/configuration/system/sites/{id}/next-ids

{base_url} is the environment URL issued to your integration. See Authenticating with Gladstone APIs.

Path parameters

Sample request

curl -X GET '{base_url}/api/configuration/system/sites/{id}/next-ids' \
  -H 'Authorization: Bearer {accessToken}' \
  -H 'X-Use-SSO: true'

Response fields

Every field below is the value the site will use next, read from the identically named system-configuration setting on that site. All start at 1 when a site is created, except nextDirectDebitDate, which starts empty. A counter whose value is an empty string is returned as 0; a counter whose value is not an integer fails the whole request with 422.

Sample response

{
  "nextAccompaniedAttendance": 1,
  "nextBookingID": 12345,
  "nextBookingRef": 1,
  "nextCancellationRef": 1,
  "nextCorrespondenceID": 12345,
  "nextDirectDebitDate": 1,
  "nextEFTRunID": 12345,
  "nextEFTTransactionID": 12345,
  "nextEventLogID": 12345,
  "nextInvoiceID": 12345,
  "nextMailID": 12345,
  "nextMemberActionID": 12345,
  "nextMemberID": 12345,
  "nextOnlineAuthID": 12345,
  "nextProductReferenceId": 12345,
  "nextSalesInvoiceID": 12345,
  "nextSalesReceiptID": 12345,
  "nextSubscriptionRef": 1,
  "nextTerminalReadingId": 12345,
  "nextUserReadingId": 12345,
  "nextWaitinglistRef": 1,
  "nextXReadingId": 12345,
  "nextZReadingId": 12345
}

Errors

This page as markdown · All pages · llms.txt