Documentación de la API

Para usar la API debe tener créditos disponibles y haber adquirido un pack al menos una vez.
POST
/API/authenticate

Obtenga su token para utilizar la API.

Solicitud con datos en formato "application/json":

{
    "email": "string",
    "password": "string"
}

Respuesta:

{
    "token": "string",
    "status_code": 0,
    "message": "string",
    "errorMessageTranslationKey": "string"
}
POST
/API/document

Suba un documento para que Braulio lo procese.

Solicitud con datos tipo "multipart/form-data":

  • file: el documento a subir

Respuesta:

{
    "data": {
        "internal_id": 0
    },
    "status_code": 0,
    "message": "string",
    "errorMessageTranslationKey": "string"
}
GET
/API/document/{id}

Obtenga el documento procesado por Braulio.

Parámetros:

  • id: el ID del documento requerido

Respuesta:

{
    "data": {
        "tenant_id": 0,
        "status_id": 0,
        "status": {
            "id": 0,
            "code": "string",
            "name": "string",
            "description": "string",
            "translation_key": "string"
        },
            "filename": "string",
            "receipt_type_id": 0,
            "receipt_type": {
            "code": "string",
            "name": "string",
            "description": "string",
            "active": true,
            "translation_key": "string"
        },
        "receipt_letter_id": 0,
        "receipt_letter": {
            "id": 0,
            "code": "string",
            "name": "string",
            "description": "string",
            "active": true,
            "translation_key": "string"
        },
        "payment_method": "string",
        "receipt_number": "string",
        "receipt_date": "string",
        "receipt_file_id": 0,
        "receipt_file": {
            "filename": "string",
            "mimetype": "string",
            "encoding": "string",
            "file": "string"
        },
        "receipt_detail": [
            {
                "receipt_header_id": 0,
                "code": "string",
                "description": "string",
                "quantity": 0,
                "unit_price": 0,
                "discount_price": 0,
                "discount_percentage": 0,
                "unit": "string",
                "product_id": 0,
                "product": {
                    "code": "string",
                    "description": "string",
                    "tenant_id": 0,
                    "id": 0
                },
                "subtotal": 0,
                "subtotal_without_tax": 0,
                "tax_rate": 0,
                "cost_center_id": "string",
                "receipt_line_number": 0,
                "receipt_line_tax_total": 0,
                "receipt_line_discount_total": 0
            }
        ],
        "has_details": true,
        "receipt_period": "string",
        "receipt_currency_id": 0,
        "currency_type": {
            "code": "string",
            "name": "string",
            "description": "string",
            "active": true,
            "translation_key": "string"
        },
        "receipt_total": 0,
        "receipt_tax_total": 0,
        "receipt_subtotal": 0,
        "receipt_discount_total": 0,
    "status_code": 0,
    "message": "string",
    "errorMessageTranslationKey": "string"
}