Skip to content
API Reference
/
/
Retrieve Incoming Peppol...

Retrieve Incoming Peppol Document Based on ID

Request

Retrieve Incoming Peppol Document based on ID

Security
api_key
Path
senderIdstringrequired

Peppol sender participant identifier

idstringrequired

Unique identifier of the Peppol Document to be retrieved

Headers
x-managed-company-idstring

Optional: the ID of the managed company on behalf of which the request is made

curl -i -X GET \
  'https://doc.acc.connect.easypost.eu/_mock/public-api/openapi/peppol-incoming-documents/sender/{senderId}/document/{id}' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-managed-company-id: string'

Responses

Bodyapplication/json
idstringrequired

Unique identifier of the Peppol Document

companyIdstringrequired

Company identifier

issueDatestring, (date-time)required

Issue Date of the Peppol Document

senderParticipantIdstringrequired

Sender Participant identification

receiverParticipantIdstringrequired

Receiver Participant identification

createdAtstring, (date-time)required

Datetime of the Peppol Document creation

lastModifiedAtstring, (date-time)required

Datetime of the last modification

lastModifiedBystringrequired

User who last modified the document

directionstringrequired

Direction of the Peppol Document

Value:"INCOMING"
senderLegalPartyRegistrationNamestring

Sender name

documentTypestring(IncomingResponseDocumentEnum)required
Default:"INVOICE_RESPONSE_3_0"
Value:"INVOICE_RESPONSE_3_0"
Discriminator
documentReferencestringrequired
responseStatusstringrequired
Enum:"SENT""NOT_SENT""ACKNOWLEDGED""IN_PROCESS""UNDER_QUERY""COND_ACCEPTED""REJECTED""ACCEPTED""PAID"
ttlnumberrequired
Response
{
  "id": "string",
  "companyId": "string",
  "issueDate": "2019-08-24T14:15:22Z",
  "senderParticipantId": "string",
  "receiverParticipantId": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "lastModifiedAt": "2019-08-24T14:15:22Z",
  "lastModifiedBy": "string",
  "direction": "INCOMING",
  "senderLegalPartyRegistrationName": "string",
  "documentType": "INVOICE_RESPONSE_3_0",
  "documentReference": "string",
  "responseStatus": "SENT",
  "ttl": 0
}