Notas de Ajuste Documento Equivalente#
Nota de Ajuste Crédito de Documento Equivalente#
Este documento permite hacer cambios, ajustes y/o correcciones a los documentos equivalentes como generar abonos o créditos a favor del cliente debido un cobro mayor en la factura de venta inicialmente transmitida, para esto, a través de Saphety en calidad de Proveedor Tecnológico autorizado por DIAN, permite realizar la generación, trasmisión para validación, validación y expedición del documento de acuerdo con los requisitos y definiciones legales del anexo técnico vigente regulado por DIAN.
A continuacion se describe los metodos y estructuras para la creacion de una Nota de Ajuste Tipo Crédito de un Documento Equivalente Electrónico.
Creación de una Nota de Ajuste Crédito de un Documento Equivalente (NAC).#
Para hacer el consumo de la API se deben tener en cuenta en que entorno se va a trabajar, SOVOS Saphety cuenta con dos ambientes especificados en el apartado de Entornos.
Consumo del método de creación.#
El Verbo Http (acción) que se utiliza para la creación de este documento es:
POST
El método que se utiliza para la creación de este documento es:
/v2/{virtualOperator}/outbounddocuments/equivalentDocumentAdjustAsync
Parameters
Para esta petición se requiere como parámetro el alias de su operador virtual.
Parametro virtualOperator
Recuerde reemplazar en el método el parámetro {virtualOperator} con el alias de su operador virtual en minúsculas, por defecto el alias es “saphety”.
Body#
Estructura del mensaje JSON de una Nota de Ajuste Tipo Crédito de un Documento Equivalente#
A continuación encontrara la estructura Base definida por Saphety para la creación de Nota de Ajuste Tipo Crédito de un Documento Equivalente
JSON (DTO)
{
"IssueDate": "2024-03-27T15:43:09.958Z",
"Currency": "COP",
"DueDate": "2024-03-27T15:43:09.958Z", //*
"DeliveryDate": "2024-03-27T15:43:09.958Z", //*
"SeriePrefix": "NCDE", //**
"SerieNumber": "2500003", //**
"ReasonCredit": "1",
"OperationType": "20",
"SerieExternalKey": "{{serieexternalkeyNCDE}}", // No tenemos resolucion de pruebas ya que DIAN no ha desplegado
"CorrelationDocumentId": "POSTMAN-{{$timestamp}}",
"PaymentMeans": [
{
"Code": "20",
"Mean": "1",
"DueDate": "2023-11-27"
}
],
"IssuerParty": {
"Identification": {
"DocumentNumber": "{{nit}}",
"DocumentType": "NIT",
"CountryCode": "CO",
"CheckDigit": "{{digitoverificacion}}"
}
},
"CustomerParty": {
"LegalType": "Legal",
"Email": "correo@sovos.com",
"TaxScheme": "ZZ",
"ResponsabilityTypes": [
"R-99-PN"
],
"Identification": {
"DocumentNumber": "{{nit}}",
"DocumentType": "NIT",
"CountryCode": "CO",
"CheckDigit": "{{digitoverificacion}}"
},
"Name": "Saphety Transacciones Electrónicas S.A.S",
"Address": {
"DepartmentCode": "11",
"CityCode": "11001",
"AddressLine": "Calle 97a No. 9 - 45",
"Country": "CO"
}
},
"Lines": [
{
"Number": "1",
"Quantity": "1",
"QuantityUnitOfMeasure": "NAR",
"TaxSubTotals": [
{
"TaxCategory": "01",
"TaxPercentage": "19.00",
"TaxableAmount": "115000.00",
"TaxAmount": "21850.00"
}
],
"TaxTotals": [
{
"TaxCategory": "01",
"TaxAmount": "21850.00"
}
],
"UnitPrice": "115000.00",
"GrossAmount": "115000.00",
"NetAmount": "115000.00",
"Item": {
"Gtin": "987654321",
"Description": "Descripcion del producto o servicio"
}
}
],
"Notes": [
"Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum. "
],
"TaxSubTotals": [
{
"TaxCategory": "01",
"TaxPercentage": "19.00",
"TaxableAmount": "115000.00",
"TaxAmount": "21850.00"
}
],
"TaxTotals": [
{
"TaxCategory": "01",
"TaxAmount": "21850.00"
}
],
"Total": {
"GrossAmount": "115000.00",
"TotalBillableAmount": "136850.00",
"PayableAmount": "136850.00",
"TaxableAmount": "115000.00",
"AllowancesTotalAmount": "0.00",
"ChargesTotalAmount": "0.00",
"PrePaidTotalAmount": "0.00"
},
"DocumentReferences": [
{
"DocumentReferred": "EPOS200",
"IssueDate": "2023-11-27T15:43:09",
"Type": "InvoiceReference",
"DocumentReferredCUFE": "16172af9c0360b1e661a57f6c232474818bd921adb200e0087c54165352f99b"
}
]
}
Términos importantes
encontrará los siguientes términos, los cuales le ayudaran a identificar la estructura del mensaje Json y la información que se debe enviar en cada campo:
A nivel global del documento: Datos generales del documento (Consecutivo del documento, medios y formas de pago, total a pagar, impuestos globales, descuentos globales, fecha emisión del documento, etc.).
A nivel de línea: Datos que detallan los productos o servicios del documento (valor unitario, impuestos, descuentos, retenciones, etc).
Emisor: Datos que hacen referencia al Emisor del documento.
Adquiriente: Datos que hacen referencia a la persona natural o Jurídica que se le emite el documento (Cliente).
Respuesta#
{
"IsValid": true,
"Warnings": [],
"Errors": [],
"ResultData": "a9d6c173-0cce-4f67-a1c0-d65811c182ad",
"ResultCode": 200
}
{
"IsValid": false,
"Warnings": [],
"Errors": [
{
"Field": "EquivalentDocumentAdjust.Currency",
"Code": "Required",
"Description": null,
"ExplanationValues": []
}
],
"ResultData": "00000000-0000-0000-0000-000000000000",
"ResultCode": 400
}
Nota de Ajuste Débito de Documento Equivalente#
Este documento permite hacer cambios, ajustes y/o correcciones a los documentos equivalentes como generar un cargo adicional al cliente debido a un cobro inferior en la factura de venta inicialmente transmitida, para esto, a través de Saphety en calidad de Proveedor Tecnológico autorizado por DIAN, permite realizar la generación, trasmisión para validación, validación y expedición del documento de acuerdo con los requisitos y definiciones legales del anexo técnico vigente regulado por DIAN.
A continuacion se describe los metodos y estructuras para la creacion de una Nota de Ajuste Tipo Débito de un Documento Equivalente Electrónico.
Creación de una Nota de Ajuste Débito de un Documento Equivalente (NAD).#
Para hacer el consumo de la API se deben tener en cuenta en que entorno se va a trabajar, SOVOS Saphety cuenta con dos ambientes especificados en el apartado de Entornos.
Consumo del método de creación.#
El Verbo Http (acción) que se utiliza para la creación de este documento es:
POST
El método que se utiliza para la creación de este documento es:
/v2/{virtualOperator}/outbounddocuments/equivalentDocumentAdjustAsync
Parameters
Para esta petición se requiere como parámetro el alias de su operador virtual.
Parametro virtualOperator
Recuerde reemplazar en el método el parámetro {virtualOperator} con el alias de su operador virtual en minúsculas, por defecto el alias es “saphety”.
Body#
Estructura del mensaje JSON de una Nota de Ajuste Tipo Débito de un Documento Equivalente#
A continuación se describe los métodos y estructuras para la creación de una Nota de Ajuste Tipo Débito de un Documento Equivalente Electrónico.
JSON (DTO)
{
"IssueDate": "2024-03-27T15:43:09.958Z",
"Currency": "COP",
"DueDate": "2024-03-27T15:43:09.958Z", //*
"DeliveryDate": "2024-03-27T15:43:09.958Z", //*
"SeriePrefix": "NDDE", //**
"SerieNumber": "2500002", //**
"ReasonDebit": "1",
"OperationType": "20",
"SerieExternalKey": "{{serieexternalkeyDEND}}", // No tenemos resolucion de pruebas ya que DIAN no ha desplegado
"CorrelationDocumentId": "POSTMAN-{{$timestamp}}",
"PaymentMeans": [
{
"Code": "20",
"Mean": "1",
"DueDate": "2023-11-27"
}
],
"IssuerParty": {
"Identification": {
"DocumentNumber": "{{nit}}",
"DocumentType": "NIT",
"CountryCode": "CO",
"CheckDigit": "{{digitoverificacion}}"
}
},
"CustomerParty": {
"LegalType": "Legal",
"Email": "correo@sovos.com",
"TaxScheme": "ZZ",
"ResponsabilityTypes": [
"R-99-PN"
],
"Identification": {
"DocumentNumber": "{{nit}}",
"DocumentType": "NIT",
"CountryCode": "CO",
"CheckDigit": "{{digitoverificacion}}"
},
"Name": "Saphety Transacciones Electrónicas S.A.S",
"Address": {
"DepartmentCode": "11",
"CityCode": "11001",
"AddressLine": "Calle 97a No. 9 - 45",
"Country": "CO"
}
},
"Lines": [
{
"Number": "1",
"Quantity": "1",
"QuantityUnitOfMeasure": "NAR",
"TaxSubTotals": [
{
"TaxCategory": "01",
"TaxPercentage": "19.00",
"TaxableAmount": "115000.00",
"TaxAmount": "21850.00"
}
],
"TaxTotals": [
{
"TaxCategory": "01",
"TaxAmount": "21850.00"
}
],
"UnitPrice": "115000.00",
"GrossAmount": "115000.00",
"NetAmount": "115000.00",
"Item": {
"Gtin": "987654321",
"Description": "Descripcion del producto o servicio"
}
}
],
"Notes": [
"Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum. "
],
"TaxSubTotals": [
{
"TaxCategory": "01",
"TaxPercentage": "19.00",
"TaxableAmount": "115000.00",
"TaxAmount": "21850.00"
}
],
"TaxTotals": [
{
"TaxCategory": "01",
"TaxAmount": "21850.00"
}
],
"Total": {
"GrossAmount": "115000.00",
"TotalBillableAmount": "136850.00",
"PayableAmount": "136850.00",
"TaxableAmount": "115000.00",
"AllowancesTotalAmount": "0.00",
"ChargesTotalAmount": "0.00",
"PrePaidTotalAmount": "0.00"
},
"DocumentReferences": [
{
"DocumentReferred": "EPOS200",
"IssueDate": "2023-11-27T15:43:09",
"Type": "InvoiceReference",
"DocumentReferredCUFE": "16172af9c0360b1e661a57f6c232474818bd921adb200e0087c54165352f99b6"
}
]
}
Terminos importantes
encontrará los siguientes términos, los cuales le ayudaran a identificar la estructura del mensaje Json y la información que se debe enviar en cada campo:
A nivel global del documento: Datos generales del documento (Consecutivo del documento, medios y formas de pago, total a pagar, impuestos globales, descuentos globales, fecha emisión del documento, etc.).
A nivel de línea: Datos que detallan los productos o servicios del documento (valor unitario, impuestos, descuentos, retenciones, etc).
Emisor: Datos que hacen referencia al Emisor del documento.
Adquiriente: Datos que hacen referencia a la persona natural o Jurídica que se le emite el documento (Cliente).
Respuesta#
{
"IsValid": true,
"Warnings": [],
"Errors": [],
"ResultData": "a9d6c173-0cce-4f67-a1c0-d65811c182ad",
"ResultCode": 200
}
{
"IsValid": false,
"Warnings": [],
"Errors": [
{
"Field": "EquivalentDocumentAdjust.Currency",
"Code": "Required",
"Description": null,
"ExplanationValues": []
}
],
"ResultData": "00000000-0000-0000-0000-000000000000",
"ResultCode": 400
}
Referencia: Swagger#
Si quieres más información dirígete a Swagger que es el modelo del API de SOVOS Saphety, para el ambiente de QA https://api-factura-electronica-co-qa.saphety.com/swagger/index.html y para el ambiente de producción https://api-factura-electronica-co.saphety.com/swagger/index.html