{"openapi":"3.0.0","info":{"description":"API de la Plataforma A9 Escrituras con Terceros\n","version":"2.0.1","title":"A9 Escrituras Terceros","termsOfService":"https://escriturad.ade/static/html/condiciones.html","contact":{"email":"integracion@gaa9.com"},"license":{"name":"Apache 2.0","url":"http://www.apache.org/licenses/LICENSE-2.0.html"}},"servers":[{"description":"SwaggerHub API Auto Mocking","url":"https://virtserver.swaggerhub.com/WIVAC15125_1/A9Escrituras/1.0.0"},{"description":"SwaggerHub API Auto Mocking","url":"https://virtserver.swaggerhub.com/XIXIL31093_1/Pydeed/1.0.0"},{"url":"https://escrituras.adeed.es/api/v1/"}],"tags":[{"name":"expediente_atc","description":"READY TO WORK - Expedientes Agencia Tributaria Catalana"},{"name":"VALIDAR_expediente_atc","description":"POR VALIDAR CON DEV TEAM"},{"name":"PENDIENTE_expediente_atc","description":"SIN REVISAR"},{"name":"expediente_registro","description":"READY TO WORK - Expedientes Registro de la Propiedad"},{"name":"VALIDAR_expediente_registro","description":"POR VALIDAR CON DEV TEAM"},{"name":"PENDIENTE_expediente_registro","description":"SIN REVISAR"}],"paths":{"/expediente_atc":{"post":{"tags":["expediente_atc"],"summary":"Creacion de un nuevo expediente ATC","operationId":"addExpedienteATC","responses":{"201":{"description":"Expediente ATC creado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RtaCreacionExpedienteATC"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RtaCreacionExpedienteATC"}}}},"400":{"description":"Input inválido"}},"requestBody":{"$ref":"#/components/requestBodies/ExpedienteATC"}},"get":{"tags":["VALIDAR_expediente_atc"],"summary":"Listado de expedientes ATC","operationId":"ListsExpedienteATC","responses":{"200":{"description":"Operación exitosa. Listado expedientes ATC obtenidos sin especificación de id_expediente particular","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ArrayDetalleExpedientesATC"}}}},"400":{"description":"Id no válido"},"404":{"description":"Expediente no encontrado"}}}},"/expediente_atc/{id_expediente}":{"get":{"tags":["VALIDAR_expediente_atc"],"summary":"Detalle de un expediente ATC","operationId":"getDetalleExpedienteATC","parameters":[{"name":"id_expediente","in":"path","description":"ID del expediente del que se quieren los detalles","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Operación exitosa. Detalle de un expediente ATC obtenido","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DetalleExpedienteATC"}}}},"400":{"description":"Id no válido"},"404":{"description":"Expediente no encontrado"}}},"put":{"tags":["PENDIENTE_expediente_atc"],"summary":"Actualización de un expediente ATC","operationId":"updateExpedienteATC","parameters":[{"name":"id_expediente","in":"path","description":"id del expediente a actualizar","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Expediente actualizado correctamente"},"400":{"description":"Id no válido"},"404":{"description":"Expediente no encontrado"},"405":{"description":"Excepción de validación"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExpedienteATC"}}},"description":"Expediente ATC actualizado","required":true}},"delete":{"tags":["PENDIENTE_expediente_atc"],"summary":"Borrado de un expediente ATC","operationId":"deleteExpedienteATC","parameters":[{"name":"id_expediente","in":"path","description":"id del expediente a actualizar","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Expediente borrado correctamente"},"400":{"description":"Id no válido"},"404":{"description":"Expediente no encontrado"},"405":{"description":"Excepción de validación"}}}},"/expediente_atc/{id_expediente}/get_documents":{"get":{"tags":["expediente_atc"],"summary":"Descarga respuesta ATC","operationId":"get_documents_atc","parameters":[{"name":"id_expediente","in":"path","description":"id del expediente","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentoRespuestaATC"}}}},"400":{"description":"Id no válido"},"404":{"description":"Expediente no encontrado"}}}},"/expediente_registro":{"post":{"tags":["expediente_registro"],"summary":"Creacion de un nuevo expediente de Registro","operationId":"addExpedienteRegistro","responses":{"201":{"description":"Expediente de Registro creado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RtaCreacionExpedienteRegistro"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RtaCreacionExpedienteRegistro"}}}},"400":{"description":"Input inválido"}},"requestBody":{"$ref":"#/components/requestBodies/ExpedienteRegistro"}},"get":{"tags":["PENDIENTE_expediente_registro"],"summary":"Listado de expedientes Registro","operationId":"ListExpedienteRegistro","responses":{"200":{"description":"Operación exitosa. Detalle de un expediente Registro obtenido","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExpedienteATC"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ExpedienteATC"}}}},"400":{"description":"Id no válido"},"404":{"description":"Expediente no encontrado"}}}},"/expediente_registro/{id_expediente}":{"get":{"tags":["PENDIENTE_expediente_registro"],"summary":"Detalle de un expediente de Registro","operationId":"getExpedienteRegistro","parameters":[{"name":"id_expediente","in":"path","description":"ID del expediente a actualizar","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Operación exitosa. Detalle de un expediente de Registro obtenido","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExpedienteRegistro"}}}},"400":{"description":"Id no válido"},"404":{"description":"Expediente no encontrado"}}},"put":{"tags":["PENDIENTE_expediente_registro"],"summary":"Actualización de un expediente de Registro","operationId":"updateExpedienteRegistro","parameters":[{"name":"id_expediente","in":"path","description":"id del expediente a actualizar","required":true,"schema":{"type":"string"}}],"responses":{"400":{"description":"Id no válido"},"404":{"description":"Expediente no encontrado"},"405":{"description":"Excepción de validación"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExpedienteRegistro"}}},"description":"Expediente Registro actualizado","required":true}},"delete":{"tags":["PENDIENTE_expediente_registro"],"summary":"Borrado de un expediente de Registro","operationId":"deleteExpedienteRegistro","parameters":[{"name":"id_expediente","in":"path","description":"id del expediente a actualizar","required":true,"schema":{"type":"string"}}],"responses":{"400":{"description":"Id no válido"},"404":{"description":"Expediente no encontrado"},"405":{"description":"Excepción de validación"}}}},"/expediente_registro/{id_expediente}/get_documents":{"get":{"tags":["PENDIENTE_expediente_registro"],"summary":"Descarga respuesta Registro","operationId":"get_documents_registro","parameters":[{"name":"id_expediente","in":"path","description":"id del expediente","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ArrayDocumentoRespuestaRegistro"}}}},"400":{"description":"Id no válido"},"404":{"description":"Expediente no encontrado"}}}}},"components":{"schemas":{"ExpedienteATC":{"type":"object","required":["doi_gestor","doi_gestoria","oficina","decs","a_facturar","callback_url"],"properties":{"doi_gestor":{"type":"string","description":"DOI de la Gestor"},"doi_gestoria":{"type":"string","description":"DOI de la Gestoria"},"oficina":{"type":"string","description":"ID único de la oficina (Facilitado por GESCO)"},"expediente_gestoria":{"type":"string","description":"Identificador interno del expediente dentro de la Gestoria"},"a_facturar":{"type":"string","description":"DOI del Gestor o de alguno de los Sujetos Pasivos o Trasnmitentes incluidos en el DEC"},"oficina_registro":{"type":"string","description":"Código de la Oficina de Registro (Si se informa, se creará un Expediente de Registro al finalizar la tramitación ATC)"},"numero_entrada_registro":{"type":"string","description":"Número de Entrada del documento a subsanar (Registro)"},"anyo_entrada_registro":{"type":"string","description":"Año de Entrada del documento a subsanar (Registro)"},"fecha_alarma":{"type":"string","description":"Fecha de alarma para el Expediente de Registro","format":"date"},"decs":{"type":"array","items":{"$ref":"#/components/schemas/DEC"},"minItems":1},"bienes_ficha":{"type":"array","items":{"$ref":"#/components/schemas/BienFicha"}},"documentos_ficha":{"type":"array","items":{"$ref":"#/components/schemas/DocFicha"}},"etiquetas":{"type":"array","items":{"$ref":"#/components/schemas/Etiqueta"},"minItems":0,"maxItems":100},"callback_url":{"type":"string","description":"URL del callback","format":"url"}},"xml":{"name":"ExpedienteATC"}},"DEC":{"type":"object","required":["nombre_fichero","iban_dec","contenido"],"properties":{"nombre_fichero":{"type":"string","description":"Nombre del fichero"},"iban_dec":{"type":"string","description":"IBAN vinculado al DEC (Tiene que estar dado de alta en la plataforma)"},"contenido":{"type":"string","description":"Contenido del dec en base64"}},"xml":{"name":"DEC"}},"BienFicha":{"type":"object","required":["tipo_bien","descripcion_bien"],"properties":{"tipo_bien":{"type":"string","description":"Tipo del Bien","enum":["T1","T2","T3","T4","T5","T6","T7","T8","T9","T10","T11","T12","T99","T100","T200","T300","T400","T500","T600"]},"descripcion_bien":{"type":"string","description":"Referencia catastral del bien"}},"xml":{"name":"BienFicha"}},"DocFicha":{"type":"object","required":["nombre_fichero","extension","contenido","tipo"],"properties":{"nombre_fichero":{"type":"string","description":"Nombre del fichero"},"extension":{"type":"string","description":"Extensión del fichero"},"contenido":{"type":"string","description":"Contenido del documento en base64"},"tipo":{"type":"string","description":"Tipo de documento","enum":["Escritura","Otro"]}},"xml":{"name":"DocFicha"}},"ArrayDetalleExpedientesATC":{"type":"object","required":["page","count","pages","results"],"properties":{"page":{"type":"string","description":"Número de página???"},"count":{"type":"string","description":"Número de Expedientes?"},"pages":{"type":"string","description":"Número de páginas totales???"},"results":{"type":"array","items":{"$ref":"#/components/schemas/DetalleExpedienteATC"},"minItems":0,"maxItems":10}}},"DetalleExpedienteATC":{"type":"object","required":["id_expediente","oficina","expediente_gestoria","doi_gestoria","doi_gestor","a_facturar","documentos_url"],"properties":{"id_expediente":{"type":"string","description":"ID del expediente detallado"},"oficina":{"type":"string","description":"ID único de la oficina (Facilitado por GESCO)"},"expediente_gestoria":{"type":"string","description":"Identificador interno del expediente dentro de la Gestoria"},"oficina_registro":{"type":"string","description":"Código de la Oficina de Registro (Si se informa, se creará un Expediente de Registro al finalizar la tramitación ATC)"},"fecha_alarma":{"type":"string","description":"Fecha de alarma para el Expediente de Registro","format":"date"},"etiquetas":{"type":"array","items":{"$ref":"#/components/schemas/Etiqueta"},"minItems":0,"maxItems":100},"doi_gestoria":{"type":"string","description":"DOI de la Gestoria"},"doi_gestor":{"type":"string","description":"DOI de la Gestor"},"a_facturar":{"type":"string","description":"DOI del Gestor o de alguno de los Sujetos Pasivos o Trasnmitentes incluidos en el DEC"},"numero_entrada_primer_envio":{"type":"string","description":"Número de Entrada del primer envio"},"anyo_entrada_primer_envio":{"type":"string","description":"Año de Entrada del primer envio"},"documentos_url":{"type":"string","description":"URL para la descarga de documentos"}}},"RtaCreacionExpedienteATC":{"type":"object","required":["id_expediente","expediente_gestoria","codigo_expediente_atc"],"properties":{"id_expediente":{"type":"string","description":"ID expediente creado"},"expediente_gestoria":{"type":"string","description":"Identificador interno del expediente dentro de la Gestoria"},"codigo_expediente_atc":{"type":"string","description":"Código expediente ATC"}}},"ExpedienteRegistro":{"type":"object","required":["doi_gestor","doi_gestoria","oficina","codigo_notario","oficina_registro","protocolo","fecha_documento","a_facturar","documentos","callback_url"],"properties":{"doi_gestor":{"type":"string","description":"DOI del Gestor"},"doi_gestoria":{"type":"string","description":"DOI de la Gestoria"},"oficina":{"type":"string","description":"ID único de la oficina (Facilitado por GESCO)"},"expediente_gestoria":{"type":"string","description":"Identificador interno del expediente dentro de la Gestoria"},"codigo_notario":{"type":"string","description":"Código del Notario"},"oficina_registro":{"type":"string","description":"Código de la Oficina de Registro"},"protocolo":{"type":"string","description":"Protocolo del Notario"},"fecha_alarma":{"type":"string","description":"Fecha alarma del registro","format":"date"},"fecha_documento":{"type":"string","description":"Fecha documento","format":"date"},"numero_entrada_registro":{"type":"string","description":"Número de Entrada del documento a subsanar (Registro)"},"anyo_entrada_registro":{"type":"string","description":"Año de Entrada del documento a subsanar (Registro)"},"a_facturar":{"type":"object","description":"Datos del Titular al que se debe generar la factura","oneOf":[{"$ref":"#/components/schemas/GestorFactura"},{"$ref":"#/components/schemas/TitularFactura"}]},"etiquetas":{"type":"array","items":{"$ref":"#/components/schemas/Etiqueta"},"minItems":0,"maxItems":100},"documentos":{"type":"array","items":{"$ref":"#/components/schemas/DocumentoRegistro"},"minItems":1,"maxItems":10},"callback_url":{"type":"string","description":"URL del callback","format":"url"}},"xml":{"name":"ExpedienteRegistro"}},"GestorFactura":{"type":"object","required":["doi"],"properties":{"doi":{"type":"string","description":"DOI del Gestor titular de la factura"}}},"TitularFactura":{"type":"object","required":["tipo_persona","nombre","doi","direccion"],"properties":{"tipo_persona":{"type":"string","description":"Tipo de Persona (Física / Jurídica) del Titular de la Factura","enum":["Física","Jurídica"]},"nombre":{"type":"string","description":"Nombre completo o Razón social del Titular de la Factura"},"doi":{"type":"string","description":"DOI del Titular de la Factura"},"direccion":{"$ref":"#/components/schemas/DireccionTitular"}},"xml":{"name":"TitularFactura"}},"DireccionTitular":{"type":"object","required":["tipo_via","nombre_via","numero","municipio","codigo_postal"],"properties":{"tipo_via":{"type":"string","description":"Tipo de vía","enum":["CALLE","PLAZA","AVD","BJADA","CTRA","PSJE","PASEO"]},"nombre_via":{"type":"string","description":"Nombre de la vía"},"numero_via":{"type":"string","description":"Nombre de la vía"},"escalera":{"type":"string","description":"Escalera"},"planta":{"type":"string","description":"Plana"},"puerta":{"type":"string","description":"Puerta"},"municipio":{"type":"string","description":"Código INE de la provincia + municipio"},"codigo_postal":{"type":"string","description":"Código postal"},"blque":{"type":"string","description":"Bloque"},"portal":{"type":"string","description":"Portal"},"kilometro":{"type":"string","description":"Kilómetro"},"hectometro":{"type":"string","description":"Hectómetro"},"pais_extranjero":{"type":"string","description":"Nombre del País extranjero"}},"xml":{"name":"DireccionTitular"}},"Etiqueta":{"type":"object","required":["etiqueta"],"properties":{"etiqueta":{"type":"string","description":"Etiqueta"}},"xml":{"name":"Etiqueta"}},"autoliquidaciones":{"type":"object","required":["autoliquidacion","carta_pago","carto_presentacion"],"properties":{"autoliquidacion":{"type":"string","description":"Código autoliquidación"},"carta_pago":{"$ref":"#/components/schemas/carta_pago"},"carta_presentacion":{"$ref":"#/components/schemas/carta_presentacion"}}},"carta_pago":{"type":"object","required":["nombre_fichero","extension","contenido"],"properties":{"nombre_fichero":{"type":"string","description":"Nombre del fichero"},"extension":{"type":"string","description":"Extensión del fichero"},"contenido":{"type":"string","description":"Contenido del fichero en base64"}}},"carta_presentacion":{"type":"object","required":["nombre_fichero","extension","contenido"],"properties":{"nombre_fichero":{"type":"string","description":"Nombre del fichero"},"extension":{"type":"string","description":"Extensión del fichero"},"contenido":{"type":"string","description":"Contenido del fichero en base64"}}},"DocumentoRegistro":{"type":"object","required":["nombre_fichero","extension","contenido"],"properties":{"nombre_fichero":{"type":"string","description":"Nombre del fichero"},"extension":{"type":"string","description":"Extensión del fichero"},"contenido":{"type":"string","description":"Contenido del fichero en base64"}},"xml":{"name":"DocumentoRegistro"}},"DocumentoRespuestaATC":{"type":"object","required":["id_expediente","codigo_expediente_atc","autoliquidaciones"],"properties":{"id_expediente":{"type":"string","description":"ID expediente"},"codigo_expediente_atc":{"type":"string","description":"Código expediente ATC"},"autoliquidaciones":{"type":"array","items":{"$ref":"#/components/schemas/autoliquidaciones"}}},"xml":{"name":"DocumentoRespuestaATC"}},"DocumentoRespuestaRegistro":{"type":"object","required":["comunicacion","tipo","fecha_recepcion","extension","contenido"],"properties":{"comunicacion":{"type":"string","description":"Codigo comunicacion"},"tipo":{"type":"string","enum":["COMUNICACION","NOTIFICACION"]},"fecha_recepcion":{"type":"string","description":"Fecha de recepción"},"nombre_fichero":{"type":"string","description":"Nombre del fichero"},"extension":{"type":"string","description":"Extensión del fichero"},"contenido":{"type":"string","description":"Contenido del fichero en base64"}},"xml":{"name":"DocumentoRespuestaRegistro"}},"ArrayDocumentoRespuestaRegistro":{"type":"array","items":{"$ref":"#/components/schemas/DocumentoRespuestaRegistro"}},"RtaCreacionExpedienteRegistro":{"type":"object","required":["id_expediente","expediente_gestoria","codigo_expediente_registro"],"properties":{"id_expediente":{"type":"string","description":"ID expediente creado"},"expediente_gestoria":{"type":"string","description":"Identificador interno del expediente dentro de la Gestoria"},"codigo_expediente_registro":{"type":"string","description":"Código expediente ATC"}}}},"requestBodies":{"ExpedienteATC":{"description":"Añade un expediente ATC","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExpedienteATC"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ExpedienteATC"}}},"required":true},"ExpedienteRegistro":{"description":"Añade un expediente RP","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExpedienteRegistro"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ExpedienteRegistro"}}},"required":true}}}}