Models/Document/DOCUMENTJSON.cs
Descripción
El modelo DocumentJson representa la estructura base de los documentos electrónicos de transporte
(ECMR) gestionados por la API. Este modelo contiene toda la información relevante del documento,
incluyendo detalles del remitente, destinatario, transportista, cargas, costos, firmas, eventos, entre
otros.
Propiedades
| Propiedad | Descripción |
|---|---|
| string? OwnerId | Identificador del propietario del documento |
| string? DocumentNumber | Número único que identifica el documento |
| string? Version | Versión del documento |
| string? JsonVersion | Versión del formato JSON del documento |
| bool? PaisUE | Indica si el país pertenece a la Unión Europea |
| string? DocumentHeader | Encabezado del documento en formato HTML |
| KeyValueList Identifiers | Lista de identificadores clave-valor relacionados con el documento |
| DocumentTypeEnum Type | Tipo de documento |
| LocationEntityType Sender | Información del remitente |
| LocationEntityType Consignee | Información del destinatario |
| LocationEntityType Destination | Información del destino |
| LocationEntityType Origin | Información del origen |
| AttachedDocumentList AttachedDocuments | Lista de documentos adjuntos |
| LoadList Loads | Lista de cargas asociadas al documento |
| long? TotalContainers | Número total de contenedores |
| CommentList SenderComments | Comentarios del remitente |
| PaymentType Payment | Información sobre el tipo de pago |
| string? CashOnDelivery | Información sobre el pago contra entrega |
| CarrierList Carriers | Lista de transportistas |
| CommentList CarrierComments | Comentarios del transportista |
| SpecialAgreementList SpecialAgreements | Lista de acuerdos especiales |
| CostList Costs | Lista de costos asociados |
| CreatedType Created | Información sobre la creación del documento |
| SignatureList Signatures | Lista de firmas asociadas |
| CommentList ConsigneeComments | Comentarios del destinatario |
| EventList Events | Lista de eventos relacionados con el documento |
| string? Instructions | Instrucciones adicionales en formato HTML |
| string? DocumentFooter | Pie de página del documento en formato HTML |
| KeyValueList OtherInformation | Información adicional clave-valor |
| List Base64Images | Lista de imágenes en formato Base64 |
| OrderedKeyValueList Annex | Anexos clave-valor ordenados |
Clases anidadas
1) KeyValueList y KeyValueOrderType
- KeyValueType: Representa una pareja clave-valor.
- KeyValueList: Lista de objetos
KeyValueTypecon métodos para obtener valores por clave.
2) LocationEntityType
Representa la información de las entidades de ubicación como remitente, destinatario, origen y destino, incluyendo dirección, VAT, identificadores de actor, observaciones y nombre.
3) AttachedDocumentList y AttachedDocumentType
Gestiona los documentos adjuntos al documento principal, incluyendo metadata sobre cada documento adjunto.
4) LoadList y LoadType
Gestiona las cargas asociadas al documento, incluyendo detalles como orden, descripción, referencia, método de embalaje, dimensiones, peso bruto, volumen, paquetes, naturaleza de los bienes, y otras propiedades pertinentes.
5) CommentList y CommentType
Gestiona los comentarios asociados al remitente, transportista y destinatario, permitiendo agregar comentarios secuencialmente.
6) PaymentType
Información relacionada con el tipo de pago, incluyendo instrucciones y comentarios.
7) CarrierList y CarrierType
Gestiona la información de los transportistas asociados al documento, incluyendo direcciones, conductores, placas, y otros detalles relevantes.
8) SpecialAgreementList y SpecialAgreementType
Gestiona los acuerdos especiales asociados al documento.
9) CostList y CostType
Gestiona los costos asociados al documento, incluyendo orden, descripción del costo, remitente y destinatario.
10) CreatedType
Información sobre la creación del documento, incluyendo lugar, fecha, y coordenadas geográficas.
11) SignatureList y SignatureType
Gestiona las firmas asociadas al documento, incluyendo tipo de firma, fecha, ubicación, lugares, y los signatarios involucrados.
12) EventList y EventType
Gestiona los eventos relacionados con el documento, incluyendo identificadores de eventos, descripciones, usuarios involucrados, fechas y versiones.