PEPPOL - Get Status

PEPPOL - Get Status (TransferStatus)

Summary

Read current status information for a PEPPOL transfer via transferId.

This operation is the status equivalent of "getStatus".

Client Usage

const result = app.businessFunction({
  functionName: "Peppol",
  methodName: "GetStatus",
  transferId: "d4afc54f-a971-4d3f-b0c0-d39e21fa5a5e"
});

Request

Required body field

  • transferId: string

Backend Routes

  • POST /Peppol/GetStatus (recommended for app.businessFunction)

  • POST /Peppol/TransferStatus (alias)

  • GET /Peppol/TransferStatus?transfer_id=<id> (compatibility)

Response (shape)

Typical Errors

  • transferId is required.

  • PEPPOL API key is missing in workspace settings.

  • Upstream 404 Not Found when transfer id does not exist in current org scope.

Processing Status Hint

For processing status interpretation, see:

  • brixxbox.Web/docs/primeExchange.md

Last updated