Skip to main content
A Source Feed is a recurring pull configured against a Source. It carries the link date (the start of the window Sintropix imports) and the credentials or handle it needs to fetch from the external system. Syncing a Feed lands new documents into its Source.
Source: apps/erp-backend/src/source-feed/source-feed.controller.ts. Base path: /api/entities/:entityId/source-feeds.

GET /source-feeds

List every Source Feed for the Entity, each annotated with its parent Source name.
  • Response: array of sourceFeedWithSourceNameSchema.

POST /source-feeds

Create a Source Feed. The response distinguishes success, redirect (the caller must complete a link flow), and error states.
  • Body: CreateSourceFeedDto.
  • Response: sourceFeedWriteAnswerSchema.

POST /source-feeds/:sourceFeedId/sync

Trigger an on-demand sync of a Source Feed. The response reports how many documents were landed, updated, or skipped.
  • Body: SyncSourceFeedDto.
  • Response: syncSourceFeedAnswerSchema.
  • Status: 200.

PATCH /source-feeds/:sourceFeedId

Change the link date on a Source Feed (the earliest date the Feed will import from).
  • Body: UpdateSourceFeedDto.
  • Response: sourceFeedWithSourceNameSchema.

DELETE /source-feeds/:sourceFeedId

Delete a Source Feed. The parent Source and any already-imported documents are unaffected.
  • Response: sourceFeedWithSourceNameSchema.

Status codes

Unverified: the full discriminant set of sourceFeedWriteAnswerSchema (success versus redirect versus error variants) and the exact provider list. Refer to @sintropix/api-contract for authoritative shapes.