POST/api/extensions/softwareone/agreements

Sync SoftwareOne agreements

Triggers the SoftwareOne agreements sync placeholder. The current handler parses the JSON body but ignores all fields, then returns a dummy count. A full implementation is expected to validate permissions, derive tenant context, call the SoftwareOne API, persist agreements, and return actual sync counts. This route is not in the middleware API-key skip list, so callers must provide x-api-key at the API layer.

Request body

Content type: application/json · schema SoftwareOneSyncRequest

fullSyncboolean

Optional future full-sync flag. Currently ignored by the MVP handlers.

syncStatementsboolean

Optional future statement sync flag. Currently ignored by the MVP handlers.

syncAgreementsboolean

Optional future agreement sync flag. Currently ignored by the MVP handlers.

Response body

Success response 200 · schema SoftwareOneSyncResponse

successbooleanRequired

Sync request completed successfully.

Enum: true

messagestringRequired

Human-readable sync result message.

countintegerRequired

Number of dummy records included in the sync result.

Response codes

200

Agreements sync placeholder completed successfully.

401

API key missing at middleware before the handler executes.

500

Unexpected failure while syncing agreements.

POST /api/extensions/softwareone/agreements

cURL

curl -X POST "https://algapsa.com/api/extensions/softwareone/agreements" \
  -H "X-API-Key: $ALGA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "fullSync": false,
  "syncStatements": false,
  "syncAgreements": false
}'

TypeScript

const response = await fetch("https://algapsa.com/api/extensions/softwareone/agreements", {
  method: "POST",
  headers: {
    "X-API-Key": "$ALGA_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "fullSync": false,
    "syncStatements": false,
    "syncAgreements": false
  })
});
const data = await response.json();

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Post, "https://algapsa.com/api/extensions/softwareone/agreements");
request.Headers.TryAddWithoutValidation("X-API-Key", "$ALGA_API_KEY");
request.Headers.TryAddWithoutValidation("Content-Type", "application/json");
request.Content = new StringContent(@"{
  ""fullSync"": false,
  ""syncStatements"": false,
  ""syncAgreements"": false
}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();

200 OK·application/json

{
  "success": true,
  "message": "string",
  "count": 1
}