{"id":39240,"date":"2026-08-11T15:40:30","date_gmt":"2026-08-11T14:40:30","guid":{"rendered":"https:\/\/developers.ila.cegid.com\/yet\/\/"},"modified":"2026-08-11T15:45:09","modified_gmt":"2026-08-11T14:45:09","slug":"how-to-send-and-retrieve-documents","status":"publish","type":"yet","link":"https:\/\/developers.ila.cegid.com\/en\/yet\/documents\/standard-scope\/article\/how-to-send-and-retrieve-documents","title":{"rendered":"How to send and retrieve documents?"},"content":{"rendered":"

This article covers how to send documents (for EDI communication or as PDFs) and how to consult documents and their states through the API.<\/p>\n<\/div><\/section>\n

Send documents<\/h2>\n

This endpoint allows you to send documents, either for EDI<\/strong> communication or by sending PDFs<\/strong>.<\/p>\n

To send a document, send the following request:<\/p>\n\n\n\n\n\n\n\n
Type<\/td>\nPOST<\/td>\n<\/tr>\n
Production<\/td>\nhttps:\/\/yet.cegid.cloud\/EDIV2\/api\/v1.3\/External\/Transaction\/Outbound<\/td>\n<\/tr>\n
Testing<\/td>\nhttps:\/\/st.yet.cegid.cloud\/EDIV2\/api\/v1.3\/External\/Transaction\/Outbound<\/td>\n<\/tr>\n
Body<\/td>\n{
\n“mainDocument”: { \/\/ required IF EDI communication
\n“content”: “”, \/\/ byte[] base64 string
\n“extension”: “xml”, \/\/ string: xml
\n“fileName”: “”, \/\/ string
\n“fileTag”: “document”, \/\/ string: document
\n“fileType”: “xml”, \/\/ string: xml|pdf|txt
\n“mimeType”: “text\/xml”, \/\/ string: text\/xml|application\/pdf
\n“id”: “”,
\n“createdAt”: “” \/\/ datetime
\n},
\n“mainDocumentPdf”: { \/\/ required IF sending PDF
\n“content”: “”, \/\/ byte[] in base64 string
\n“extension”: “pdf”, \/\/ string: pdf
\n“fileName”: “”, \/\/ string
\n“fileTag”: “document”, \/\/ string: document
\n“fileType”: “pdf”, \/\/ string: pdf
\n“mimeType”: “application\/pdf”, \/\/ string: application\/pdf
\n“id”: “”,
\n“createdAt”: “” \/\/ datetime
\n},
\n“attachmentsLits”: [ \/\/ optional
\n{
\n“content”: “”, \/\/ byte[] base64 string
\n“extension”: “pdf”, \/\/ string: pdf|xml|zip|txt
\n“fileName”: “”, \/\/ string
\n“fileTag”: “Attachment”, \/\/ string: Attachment
\n“fileType”: “pdf”, \/\/ string: pdf|xml|zip|txt
\n“mimeType”: “application\/pdf”,
\n“id”: “”,
\n“createdAt”: “” \/\/ datetime
\n}
\n]
\n}<\/td>\n<\/tr>\n
Response<\/td>\n201 Created:
\n{
\n“id”: “3fa85f64-5717-4562-b3fc-2c963f66afa6”,
\n“docType”: “string”,
\n“docNumber”: “string”,
\n“docDate”: “2025-02-23T15:43:04.887Z”,
\n“docDescription”: “string”,
\n“buyerGln”: “string”,
\n“deliveryGln”: “string”,
\n“invoiceToGln”: “string”,
\n“supplierGln”: “string”,
\n“b2centity”: {
\n“id”: “3fa85f64-5717-4562-b3fc-2c963f66afa6”,
\n“name”: “string”,
\n“codeIdentifier”: “string”,
\n“email”: “string”,
\n“mobilePhone”: “string”,
\n“contacts”: [
\n{
\n“id”: “3fa85f64-5717-4562-b3fc-2c963f66afa6”,
\n“name”: “string”,
\n“email”: “string”,
\n“enable”: true,
\n“mobilePhone”: “string”,
\n“sendMailType”: “CC”
\n}
\n]
\n},
\n“documentType”: “Generic”,
\n“documentExtenion”: “EDI”,
\n“comercialRelation”: {
\n“id”: “3fa85f64-5717-4562-b3fc-2c963f66afa6”,
\n“senderOrganization”: {
\n“id”: “3fa85f64-5717-4562-b3fc-2c963f66afa6”,
\n“communicationType”: “AS2”,
\n“integrationType”: “EDI”,
\n“documentExtension”: “EDI”,
\n“b2bformat”: “PRI”,
\n“erpProviderId”: “3fa85f64-5717-4562-b3fc-2c963f66afa6”,
\n“identifier”: “string”,
\n“inboundPath”: “string”,
\n“outboundPath”: “string”,
\n“name”: “string”,
\n“invoiceRepository”: true,
\n“autoComercialRelation”: true,
\n“mainDeliveryPlace”: {
\n“id”: “3fa85f64-5717-4562-b3fc-2c963f66afa6″,”code”: “string”,
\n“name”: “string”,
\n“address”: “string”,
\n“city”: “string”,
\n“country”: “string”,
\n“postalCode”: “string”,
\n“vatNumber”: “string”
\n},
\n“organizationInfo”: {
\n“billingCommission”: true,
\n“id”: “3fa85f64-5717-4562-b3fc-2c963f66afa6”,
\n“name”: “string”,
\n“vatNumber”: “string”,
\n“organizationType”: “string”
\n}
\n},
\n“receiverOrganization”: {
\n“id”: “3fa85f64-5717-4562-b3fc-2c963f66afa6”,
\n“communicationType”: “AS2”,
\n“integrationType”: “EDI”,
\n“documentExtension”: “EDI”,
\n“b2bformat”: “PRI”,
\n“erpProviderId”: “3fa85f64-5717-4562-b3fc-2c963f66afa6”,
\n“identifier”: “string”,
\n“inboundPath”: “string”,
\n“outboundPath”: “string”,
\n“name”: “string”,
\n“invoiceRepository”: true,
\n“autoComercialRelation”: true,
\n“mainDeliveryPlace”: {
\n“id”: “3fa85f64-5717-4562-b3fc-2c963f66afa6”,
\n“code”: “string”,
\n“name”: “string”,
\n“address”: “string”,
\n“city”: “string”,
\n“country”: “string”,
\n“postalCode”: “string”,
\n“vatNumber”: “string”
\n},
\n“organizationInfo”: {
\n“billingCommission”: true,
\n“id”: “3fa85f64-5717-4562-b3fc-2c963f66afa6”,
\n“name”: “string”,
\n“vatNumber”: “string”,
\n“organizationType”: “string”
\n}
\n},<\/p>\n

“documentType”: “Generic”,
\n“van”: {
\n“id”: “3fa85f64-5717-4562-b3fc-2c963f66afa6”,
\n“name”: “string”,
\n“username”: “string”,
\n“password”: “string”,
\n“inboundPath”: “string”,
\n“outboundPath”: “string”,
\n“ssl”: “string”,
\n“port”: “string”,
\n“testName”: “string”,
\n“testUsername”: “string”,
\n“testPassword”: “string”,
\n“testInboundPath”: “string”,
\n“testOutboundPath”: “string”,
\n“testSSL”: “string”,
\n“testPort”: “string”,
\n“endPointUrl”: “string”,
\n“useWs”: true
\n},
\n“active”: true,
\n“isOnTeste”: true,
\n“mapName”: “string”,
\n“isPDFMandatory”: true,
\n“isJasminSync”: true,
\n“layoutReceiver”: {
\n“id”: “3fa85f64-5717-4562-b3fc-2c963f66afa6”,
\n“organization”: {
\n“id”: “3fa85f64-5717-4562-b3fc-2c963f66afa6”,
\n“communicationType”: “AS2”,
\n“integrationType”: “EDI”,
\n“documentExtension”: “EDI”,
\n“b2bformat”: “PRI”,
\n“erpProviderId”: “3fa85f64-5717-4562-b3fc-2c963f66afa6”,
\n“identifier”: “string”,
\n“inboundPath”: “string”,
\n“outboundPath”: “string”,
\n“name”: “string”,
\n“invoiceRepository”: true,
\n“autoComercialRelation”: true,
\n“mainDeliveryPlace”: {
\n“id”: “3fa85f64-5717-4562-b3fc-2c963f66afa6”,
\n“code”: “string”,
\n“name”: “string”,
\n“address”: “string”,
\n“city”: “string”,
\n“country”: “string”,<\/p>\n

“postalCode”: “string”,
\n“vatNumber”: “string”
\n},
\n“organizationInfo”: {
\n“billingCommission”: true,
\n“id”: “3fa85f64-5717-4562-b3fc-2c963f66afa6”,
\n“name”: “string”,
\n“vatNumber”: “string”,
\n“organizationType”: “string”
\n}
\n},
\n“layoutDocument”: {
\n“id”: “3fa85f64-5717-4562-b3fc-2c963f66afa6”,
\n“layoutId”: “3fa85f64-5717-4562-b3fc-2c963f66afa6”,
\n“documentTypeEnum”: “Generic”,
\n“direction”: true,
\n“mapa”: “string”,
\n“formatTypeEnum”: “XML”,
\n“segmento”: “string”,
\n“separator”: “string”,
\n“senderStart”: “string”,
\n“senderEnd”: “string”,
\n“receiverStart”: “string”,
\n“receiverEnd”: “string”,
\n“documentTypeStart”: “string”,
\n“documentTypeEnd”: “string”,
\n“documentTypeFileCode”: “string”,
\n“numberStart”: “string”,
\n“numberEnd”: “string”,
\n“dateStart”: “string”,
\n“dateEnd”: “string”,
\n“dateFormat”: “string”,
\n“bpPreExecution”: “string”,
\n“bpPosExecution”: “string”,
\n“layout”: {
\n“id”: “3fa85f64-5717-4562-b3fc-2c963f66afa6”,
\n“name”: “string”,
\n“description”: “string”,
\n“layoutDocuments”: [
\n“string”
\n]
\n},
\n“van”: {
\n“id”: “3fa85f64-5717-4562-b3fc-2c963f66afa6”,
\n“name”: “string”,
\n“username”: “string”,
\n“password”: “string”,<\/p>\n

“inboundPath”: “string”,
\n“outboundPath”: “string”,
\n“ssl”: “string”,
\n“port”: “string”,
\n“testName”: “string”,
\n“testUsername”: “string”,
\n“testPassword”: “string”,
\n“testInboundPath”: “string”,
\n“testOutboundPath”: “string”,
\n“testSSL”: “string”,
\n“testPort”: “string”,
\n“endPointUrl”: “string”,
\n“useWs”: true
\n}
\n},
\n“layoutDefault”: true
\n},
\n“layoutSender”: {
\n“id”: “3fa85f64-5717-4562-b3fc-2c963f66afa6”,
\n“organization”: {
\n“id”: “3fa85f64-5717-4562-b3fc-2c963f66afa6”,
\n“communicationType”: “AS2”,
\n“integrationType”: “EDI”,
\n“documentExtension”: “EDI”,
\n“b2bformat”: “PRI”,
\n“erpProviderId”: “3fa85f64-5717-4562-b3fc-2c963f66afa6”,
\n“identifier”: “string”,
\n“inboundPath”: “string”,
\n“outboundPath”: “string”,
\n“name”: “string”,
\n“invoiceRepository”: true,
\n“autoComercialRelation”: true,
\n“mainDeliveryPlace”: {
\n“id”: “3fa85f64-5717-4562-b3fc-2c963f66afa6”,
\n“code”: “string”,
\n“name”: “string”,
\n“address”: “string”,
\n“city”: “string”,
\n“country”: “string”,
\n“postalCode”: “string”,
\n“vatNumber”: “string”
\n},
\n“organizationInfo”: {
\n“billingCommission”: true,
\n“id”: “3fa85f64-5717-4562-b3fc-2c963f66afa6”,
\n“name”: “string”,
\n“vatNumber”: “string”,<\/p>\n

“testOutboundPath”: “string”,
\n“testSSL”: “string”,
\n“testPort”: “string”,
\n“endPointUrl”: “string”,
\n“useWs”: true
\n}
\n},
\n“layoutDefault”: true
\n}
\n},
\n“van”: {
\n“id”: “3fa85f64-5717-4562-b3fc-2c963f66afa6”,
\n“name”: “string”,
\n“username”: “string”,
\n“password”: “string”,
\n“inboundPath”: “string”,
\n“outboundPath”: “string”,
\n“ssl”: “string”,
\n“port”: “string”,
\n“testName”: “string”,
\n“testUsername”: “string”,
\n“testPassword”: “string”,
\n“testInboundPath”: “string”,
\n“testOutboundPath”: “string”,
\n“testSSL”: “string”,
\n“testPort”: “string”,
\n“endPointUrl”: “string”,
\n“useWs”: true
\n},
\n“transactionState”: “PendingParser”,
\n“transactionType”: “QuickInvoice”,
\n“organizationOwner”: {
\n“id”: “3fa85f64-5717-4562-b3fc-2c963f66afa6”,
\n“communicationType”: “AS2”,
\n“integrationType”: “EDI”,
\n“documentExtension”: “EDI”,
\n“b2bformat”: “PRI”,
\n“erpProviderId”: “3fa85f64-5717-4562-b3fc-2c963f66afa6”,
\n“identifier”: “string”,
\n“inboundPath”: “string”,
\n“outboundPath”: “string”,
\n“name”: “string”,
\n“invoiceRepository”: true,
\n“autoComercialRelation”: true,
\n“mainDeliveryPlace”: {
\n“id”: “3fa85f64-5717-4562-b3fc-2c963f66afa6”,
\n“code”: “string”,<\/p>\n

“name”: “string”,
\n“address”: “string”,
\n“city”: “string”,
\n“country”: “string”,
\n“postalCode”: “string”,
\n“vatNumber”: “string”
\n},
\n“organizationInfo”: {
\n“billingCommission”: true,
\n“id”: “3fa85f64-5717-4562-b3fc-2c963f66afa6”,
\n“name”: “string”,
\n“vatNumber”: “string”,
\n“organizationType”: “string”
\n}
\n},
\n“alreadySent”: true,
\n“direction”: true,
\n“createdAt”: “2025-02-23T15:43:04.888Z”,
\n“documentDetails”: “string”
\n}
\n409 Conflict or 500 Internal Server Error:
\n{
\n“type”: “string”,
\n“title”: “string”,
\n“status”: 0,
\n“detail”: “string”,
\n“instance”: “string”,
\n“additionalProp1”: “string”,
\n“additionalProp2”: “string”,
\n“additionalProp3”: “string”
\n}<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div><\/section>\n

Get sent documents<\/h2>\n

This request returns all the documents sen<\/strong>t. You can set the top and skip parameters, which allow you to define the number of documents you want to get.<\/p>\n

To retrieve sent documents, send the following request:<\/p>\n\n\n\n\n\n\n
Type<\/td>\nGET<\/td>\n<\/tr>\n
Production<\/td>\nhttps:\/\/yet.cegid.cloud\/EDIV2\/api\/v1.3\/External\/Transaction?$count=true&$top=100&$skip=100<\/td>\n<\/tr>\n
Testing<\/td>\nhttps:\/\/st.yet.cegid.cloud\/EDIV2\/api\/v1.3\/External\/Transaction?$count=true&$top=100&$skip=100<\/td>\n<\/tr>\n
Response<\/td>\n200 Ok:
\n[
\n{
\n“transactionId”: “3fa85f64-5717-4562-b3fc-2c963f66afa6”,
\n“files”: [
\n{
\n“id”: “3fa85f64-5717-4562-b3fc-2c963f66afa6”,
\n“fileType”: “JSON”,
\n“fileTag”: “CertificateContractSent”,
\n“content”: “string”,
\n“extension”: “string”,
\n“mimeType”: “string”,
\n“fileName”: “string”,
\n“createdAt”: “2025-02-23T15:45:02.788Z”
\n}
\n]
\n}
\n]
\n404 Not Found or 500 Internal Server Error:
\n{
\n“type”: “string”,
\n“title”: “string”,
\n“status”: 0,
\n“detail”: “string”,
\n“instance”: “string”,
\n“additionalProp1”: “string”,
\n“additionalProp2”: “string”,
\n“additionalProp3”: “string”
\n}<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div><\/section>\n

Get a specific document<\/h2>\n

It is possible to obtain a specific document<\/strong> via its identifier. This identifier<\/strong> is returned by the Send Documents<\/strong> request, above.<\/p>\n

To retrieve a specific document, send the following request:<\/p>\n\n\n\n\n\n\n\n
Type<\/td>\nGET<\/td>\n<\/tr>\n
Production<\/td>\nhttps:\/\/yet.cegid.cloud\/EDIV2\/api\/v1.3\/External\/Transaction\/{{transactionId}}<\/td>\n<\/tr>\n
Testing<\/td>\nhttps:\/\/st.yet.cegid.cloud\/EDIV2\/api\/v1.3\/External\/Transaction\/{{transactionId}}<\/td>\n<\/tr>\n
Route params<\/td>\ntransactionId: \u201cguid\u201d \/\/ ID of the created document<\/td>\n<\/tr>\n
Response<\/td>\n200 Ok: Same response 4.1
\n404 Not Found or 500 Internal Server Error:
\n{
\n“type”: “string”,
\n“title”: “string”,
\n“status”: 0,
\n“detail”: “string”,
\n“instance”: “string”,
\n“additionalProp1”: “string”,
\n“additionalProp2”: “string”,
\n“additionalProp3”: “string”
\n}<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div><\/section>\n

Received documents<\/h2>\n

This request returns the documents to be received<\/strong>, in “To Export”<\/strong> state. After this request, all the exported documents will be in “Exported”<\/strong> state.<\/p>\n

To retrieve received documents, send the following request:<\/p>\n\n\n\n\n\n\n
Type<\/td>\nGET<\/td>\n<\/tr>\n
Production<\/td>\nhttps:\/\/yet.cegid.cloud\/EDIV2\/api\/v1.3\/External\/Transaction\/ExportAll<\/td>\n<\/tr>\n
Testing<\/td>\nhttps:\/\/st.yet.cegid.cloud\/EDIV2\/api\/v1. 3\/External\/Transaction\/ExportAll<\/td>\n<\/tr>\n
Response<\/td>\n200 OK
\n[
\n{
\n“transactionId”: “3fa85f64-5717-4562-b3fc-2c963f66afa6”,
\n“files”: [
\n{
\n“id”: “3fa85f64-5717-4562-b3fc-2c963f66afa6”,
\n“fileType”: “JSON”,
\n“fileTag”: “CertificateContractSent”,
\n“content”: “string”,
\n“extension”: “string”,
\n“mimeType”: “string”,
\n“fileName”: “string”,
\n“createdAt”: “2025-02-23T15:46:42.018Z”
\n}
\n]
\n}
\n]
\n404 Not Found or 500 Internal Server Error:
\n{
\n“type”: “string”,
\n“title”: “string”,
\n“status”: 0,
\n“detail”: “string”,
\n“instance”: “string”,
\n“additionalProp1”: “string”,
\n“additionalProp2”: “string”,
\n“additionalProp3”: “string”
\n}<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div><\/section>\n","protected":false},"excerpt":{"rendered":"","protected":false},"featured_media":0,"menu_order":0,"comment_status":"open","ping_status":"open","template":"","format":"standard","tags":[1090],"videos_tax":[],"post-type":[300],"categoria-yet":[1081],"class_list":["post-39240","yet","type-yet","status-publish","format-standard","hentry","tag-documents","post-type-artigo","categoria-yet-standard-scope"],"_links":{"self":[{"href":"https:\/\/developers.ila.cegid.com\/en\/wp-json\/wp\/v2\/yet\/39240","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/developers.ila.cegid.com\/en\/wp-json\/wp\/v2\/yet"}],"about":[{"href":"https:\/\/developers.ila.cegid.com\/en\/wp-json\/wp\/v2\/types\/yet"}],"replies":[{"embeddable":true,"href":"https:\/\/developers.ila.cegid.com\/en\/wp-json\/wp\/v2\/comments?post=39240"}],"version-history":[{"count":0,"href":"https:\/\/developers.ila.cegid.com\/en\/wp-json\/wp\/v2\/yet\/39240\/revisions"}],"wp:attachment":[{"href":"https:\/\/developers.ila.cegid.com\/en\/wp-json\/wp\/v2\/media?parent=39240"}],"wp:term":[{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/developers.ila.cegid.com\/en\/wp-json\/wp\/v2\/tags?post=39240"},{"taxonomy":"videos_tax","embeddable":true,"href":"https:\/\/developers.ila.cegid.com\/en\/wp-json\/wp\/v2\/videos_tax?post=39240"},{"taxonomy":"post-type","embeddable":true,"href":"https:\/\/developers.ila.cegid.com\/en\/wp-json\/wp\/v2\/post-type?post=39240"},{"taxonomy":"categoria-yet","embeddable":true,"href":"https:\/\/developers.ila.cegid.com\/en\/wp-json\/wp\/v2\/categoria-yet?post=39240"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}