Acuse de Recibo de un Documento#
El acuse de recibo es la notificación que realiza el adquiriente cuando recibe un documento electrónico emitido sobre algún bien y/o servicio adquirido para informar que recibió la compra.
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 para realizar acuse de recibo.#
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 encontrara 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#
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