How to check document traceability and notifications?
This article covers how to check the latest traceability of a document, how to retrieve the latest notifications, and what the possible document status values mean. This endpoint returns the latest traceability of a specific document through its identifier. This identifier is returned by the Send documents request. To retrieve the latest traceability, send the following request: Use this request to check a document's latest notification, which reflects the document's current state. You'll need the transaction identifier returned by the Send documents request. If the document is in error, the response includes notification notes with more detail. You can also skip filtering by a specific document and retrieve all notifications from a given date onward instead. To do this, filter by createdAt greater than the desired date, and, since these are outbound transactions, include transaction/direction = false. To retrieve the latest notifications, send the following request: "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "testName": "string", }, "testPort": "string", "segmento": "string", "van": { "name": "string", A document goes through several processing steps before reaching its destination. Use the Get latest notifications request above to check whether a document has been sent, is pending, or has run into an error. Note: After a document is sent to its destination and is in the Sent state, it is still possible to get errors returned by the receiver.Receive latest document traceability
Type GET Production https://yet.cegid.cloud/EDIV2/api/v1.3/ External/Transaction/{transactionId}/Traceability/Latest Testing https://st.yet.cegid.cloud /EDIV2/api/v1.3/ External/Transaction/{transactionId}/Traceability/Latest Response 200 Ok
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"log": "string",
"traceabilityFiles": [
{
"file": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"fileType": "JSON",
"fileTag": "CertificateContractSent",
"content": "string",
"extension": "string",
"mimeType": "string",
"fileName": "string",
"createdAt": "2025-02-23T23:57:56.014Z"
},
"fileTag": "CertificateContractSent"
}
]
}
409 Conflit or 500 Internal Server Error:
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}Get latest notifications
Type GET Production https://yet.cegid.cloud/EDIV2/api/v1.3/External/Notification?$count=true&$orderby=date
desc&$filter=Transaction/id eq {{TransactionId}}Testing https://st.yet.cegid.cloud/EDIV2/api/v1.3/External?$count=true&$orderby=date
desc&$filter=Transaction/id eq {{TransactionId}}Alternative filter for all notifications from a specific date $filter=createdAt ge {{StartDate}} and transaction/direction eq false Route params transactionId: “guid” // identifier of the document created Response {
"items": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"notificationState": "ErrorOccurred",
"notificationType": "Send",
"notificationNoteType": "SecurityError",
"date": "2025-02-24T00:02:16.527Z",
"transaction": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"docType": "string",
"docNumber": "string",
"docDate": "2025-02-24T00:02:16.527Z",
"docDescription": "string",
"buyerGln": "string",
"deliveryGln": "string",
"invoiceToGln": "string","supplierGln": "string",
"b2centity": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"codeIdentifier": "string",
"email": "string",
"mobilePhone": "string",
"contacts": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"email": "string",
"enable": true,
"mobilePhone": "string",
"sendMailType": "CC"
}
]
},
"documentType": "Generic",
"documentExtenion": "EDI",
"comercialRelation": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"senderOrganization": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"communicationType": "AS2",
"integrationType": "EDI",
"documentExtension": "EDI",
"b2bformat": "PRI",
"erpProviderId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"identifier": "string",
"inboundPath": "string",
"outboundPath": "string",
"name": "string",
"invoiceRepository": true,
"autoComercialRelation": true,
"mainDeliveryPlace": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"code": "string",
"name": "string",
"address": "string",
"city": "string",
"country": "string",
"postalCode": "string",
"vatNumber": "string"
},
"organizationInfo": {
"billingCommission": true,
"name": "string",
"vatNumber": "string",
"organizationType": "string"
}
},
"receiverOrganization": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"communicationType": "AS2",
"integrationType": "EDI",
"documentExtension": "EDI",
"b2bformat": "PRI",
"erpProviderId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"identifier": "string",
"inboundPath": "string",
"outboundPath": "string",
"name": "string",
"invoiceRepository": true,
"autoComercialRelation": true,
"mainDeliveryPlace": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"code": "string",
"name": "string",
"address": "string",
"city": "string",
"country": "string",
"postalCode": "string",
"vatNumber": "string"
},
"organizationInfo": {
"billingCommission": true,
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"vatNumber": "string",
"organizationType": "string"
}
},
"documentType": "Generic",
"van": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"username": "string",
"password": "string",
"inboundPath": "string",
"outboundPath": "string",
"ssl": "string",
"port": "string",
"testUsername": "string",
"testPassword": "string",
"testInboundPath": "string",
"testOutboundPath": "string",
"testSSL": "string",
"testPort": "string",
"endPointUrl": "string",
"useWs": true
},
"active": true,
"isOnTeste": true,
"mapName": "string",
"isPDFMandatory": true,
"isJasminSync": true,
"layoutReceiver": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"organization": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"communicationType": "AS2",
"integrationType": "EDI",
"documentExtension": "EDI",
"b2bformat": "PRI",
"erpProviderId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"identifier": "string",
"inboundPath": "string",
"outboundPath": "string",
"name": "string",
"invoiceRepository": true,
"autoComercialRelation": true,
"mainDeliveryPlace": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"code": "string",
"name": "string",
"address": "string",
"city": "string",
"country": "string",
"postalCode": "string",
"vatNumber": "string"
},
"organizationInfo": {
"billingCommission": true,
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"vatNumber": "string",
"organizationType": "string"
}
"layoutDocument": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"layoutId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"documentTypeEnum": "Generic",
"direction": true,
"mapa": "string",
"formatTypeEnum": "XML",
"segmento": "string",
"separator": "string",
"senderStart": "string",
"senderEnd": "string",
"receiverStart": "string",
"receiverEnd": "string",
"documentTypeStart": "string",
"documentTypeEnd": "string",
"documentTypeFileCode": "string",
"numberStart": "string",
"numberEnd": "string",
"dateStart": "string",
"dateEnd": "string",
"dateFormat": "string",
"bpPreExecution": "string",
"bpPosExecution": "string",
"layout": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"description": "string",
"layoutDocuments": [
"string"
]
},
"van": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"username": "string",
"password": "string",
"inboundPath": "string",
"outboundPath": "string",
"ssl": "string",
"port": "string",
"testName": "string",
"testUsername": "string",
"testPassword": "string",
"testInboundPath": "string",
"testOutboundPath": "string",
"testSSL": "string",
"endPointUrl": "string",
"useWs": true
}
},
"layoutDefault": true
},
"layoutSender": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"organization": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"communicationType": "AS2",
"integrationType": "EDI",
"documentExtension": "EDI",
"b2bformat": "PRI",
"erpProviderId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"identifier": "string",
"inboundPath": "string",
"outboundPath": "string",
"name": "string",
"invoiceRepository": true,
"autoComercialRelation": true,
"mainDeliveryPlace": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"code": "string",
"name": "string",
"address": "string",
"city": "string",
"country": "string",
"postalCode": "string",
"vatNumber": "string"
},
"organizationInfo": {
"billingCommission": true,
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"vatNumber": "string",
"organizationType": "string"
}
},
"layoutDocument": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"layoutId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"documentTypeEnum": "Generic",
"direction": true,
"mapa": "string",
"formatTypeEnum": "XML",
"separator": "string",
"senderStart": "string",
"senderEnd": "string",
"receiverStart": "string",
"receiverEnd": "string",
"documentTypeStart": "string",
"documentTypeEnd": "string",
"documentTypeFileCode": "string",
"numberStart": "string",
"numberEnd": "string",
"dateStart": "string",
"dateEnd": "string",
"dateFormat": "string",
"bpPreExecution": "string",
"bpPosExecution": "string",
"layout": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"description": "string",
"layoutDocuments": [
"string"
]
},
"van": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"username": "string",
"password": "string",
"inboundPath": "string",
"outboundPath": "string",
"ssl": "string",
"port": "string",
"testName": "string",
"testUsername": "string",
"testPassword": "string",
"testInboundPath": "string",
"testOutboundPath": "string",
"testSSL": "string",
"testPort": "string",
"endPointUrl": "string",
"useWs": true
}
},
"layoutDefault": true
}
},
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"username": "string",
"password": "string",
"inboundPath": "string",
"outboundPath": "string",
"ssl": "string",
"port": "string",
"testName": "string",
"testUsername": "string",
"testPassword": "string",
"testInboundPath": "string",
"testOutboundPath": "string",
"testSSL": "string",
"testPort": "string",
"endPointUrl": "string",
"useWs": true
},
"transactionState": "PendingParser",
"transactionType": "QuickInvoice",
"organizationOwner": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"communicationType": "AS2",
"integrationType": "EDI",
"documentExtension": "EDI",
"b2bformat": "PRI",
"erpProviderId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"identifier": "string",
"inboundPath": "string",
"outboundPath": "string",
"name": "string",
"invoiceRepository": true,
"autoComercialRelation": true,
"mainDeliveryPlace": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"code": "string",
"name": "string",
"address": "string",
"city": "string",
"country": "string",
"postalCode": "string",
"vatNumber": "string"
},
"organizationInfo": {
"billingCommission": true,
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"vatNumber": "string",
"organizationType": "string"
}
},
"alreadySent": true,
"direction": true,
"createdAt": "2025-02-24T00:02:16.528Z",
"documentDetails": "string"
},
"notificationNotes": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"note": "string"
}
],
"errorCode": "string",
"invoiceRefusedMotive": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"code": "string",
"description": "string",
"createdAt": "2025-02-24T00:02:16.528Z",
"createdBy": "string"
}
}
],
"nextPageLink": "string",
"count": 0
}
400 Bad Request or 500 Internal Server Error:
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}Document status values
Status Description PendingParser The document is in queue to be processed. PendingSend The document is pending to be sent by email. Error The document has an error in its structure or is missing some configuration (see the notification notes). Sent The document has been sent.