Refresh the delivery status of a sent document

POST

https://service.invoice-api.xhub.io/api/v1/peppol/transmissions/:messageId/refresh

POST

/api/v1/peppol/transmissions/:messageId/refresh

curl -X POST https://service.invoice-api.xhub.io/api/v1/peppol/transmissions/messageId/refresh \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{}'

{
  "success": true,
  "transmission": {
    "id": "id",
    "organizationId": "organizationId",
    "invoiceId": "invoiceId",
    "direction": "outbound",
    "providerName": "storecove",
    "messageId": "messageId",
    "senderPeppolId": "9930:DE123456789",
    "receiverPeppolId": "9930:DE987654321",
    "documentType": "documentType",
    "status": "pending",
    "errorCode": "errorCode",
    "errorMessage": "errorMessage",
    "contentHash": "contentHash",
    "createdAt": "2024-01-15T09:30:00Z",
    "updatedAt": "2024-01-15T09:30:00Z",
    "statusAt": "2024-01-15T09:30:00Z"
  },
  "errorCode": "errorCode",
  "errorMessage": "errorMessage"
}

Re-queries the Access Point for the current delivery status and syncs the transmissions log row. Synthetic local-* ids (failed sends that never reached the provider) are returned unchanged.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

messageIdstringRequired

Request

This endpoint expects an object.

environmentenumOptionalDefaults to production

Peppol settings scope to use (which provider config + API key)

Allowed values:

Response

Current transmission state

successboolean

transmissionobject or null

Persisted log row — present for every attempt that reached the provider

errorCodestringOptional

errorMessagestringOptional

Errors

400

Refresh Transmission Peppol Request Bad Request Error

404

Refresh Transmission Peppol Request Not Found Error

501

Refresh Transmission Peppol Request Not Implemented Error