Acuse de Recibo de un Documento

Acuse de Recibo de un Documento#

El acuse de recibo es la notificación que realiza el adquiriente al recibir un documento electrónico emitido por la compra de un bien y/o servicio, con el fin de informar que ha recibido dicha transacción.

Para consumir la API, es importante considerar el entorno en el que se va a trabajar. SOVOS Saphety dispone de dos ambientes, los cuales se especifican en el apartado de Entornos.

Consumo del método para realizar acuse de recibo.#

acuseRecibo

El Verbo Http (acción) que se utiliza para la consulta de este formato es:

POST

El método que se utiliza para la consulta de este formato es:

    /v2/{virtualOperator}/inbounddocuments/{id}/receive

Para esta petición se requiere como parámetro el alias de su operador virtual y el codigo de la compañia companyId.

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”.

Parametro id

Recuerde reemplazar en el método el parámetro {id} con el codigo identificador unico del documento recibido.

Body#

Estructura del mensaje JSON para realizar el acuse de recibo.#

A continuación encontrará la estructura base definida por Saphety para realizar el acuse de recibo.

JSON (DTO)
{
  "FirstName": "Pepito",
  "FamilyName": "Perez",
  "JobTitle": "Facturador Electrónico",
  "OrganizationDepartment": "Contabilidad",
  "Identification": {
    "DocumentNumber": "80844005",
    "DocumentType": "NIT",
    "CountryCode": "CO",
    "CheckDigit": "1"
  }
}

Respuesta#

{
   "IsValid":true,
   "Warnings":[],
   "Errors":[],
   "ResultData":true,
   "ResultCode":200
}

{
    "IsValid": false,
    "Warnings": [],
    "Errors": [
        {
            "Field": null,
            "Code": "UnauthorizedUserToExecuteOperation",
            "Description": null,
            "ExplanationValues": []
        }
    ],
    "ResultData": false,
    "ResultCode": 400
}

Referencia: Swagger#

Para obtener más información, puedes consultar la documentación del API de SOVOS Saphety en Swagger. A continuación, se indican los enlaces según el ambiente: