Payment Document Endpoints — FAC_DOCUMENTO_PAGO API

Payment documents (comprobantes de pago) are the official billing artifacts — invoices, boletas, or receipts — generated by the clinic when a patient’s medical attendance is fully settled. Each comprobante is anchored to a specific patient attendance (id_atencion), carries a header that records the billing party details, applicable taxes, currency, and totals, and contains one or more line items (FAC_COMPROBANTE_DetalleDTO) that itemize every service or procedure rendered, each cross-referenced to the insurance tariff catalog (CVN_TARIFARIO_SEGUS). The FAC_DOCUMENTO_PAGO controller exposes two operations: a filtered search for existing comprobantes, and a compound insert that saves the header and all line items in a single atomic call (Add2 at the business layer).

Common Response Envelope

Every endpoint returns the shared JsonResponse wrapper:

{
  "Success": true,
  "Warning": false,
  "Message": "...",
  "Data": { ... }
}

Field	Type	Description
`Success`	boolean	`true` unless an unhandled exception occurred.
`Warning`	boolean	`true` when the operation was blocked by a business rule.
`Message`	string	Human-readable result message in Spanish.
`Data`	any	List of `FAC_DOCUMENTO_PAGODTO` objects on search; `null` on insert.

Endpoints

POST /api/FAC_DOCUMENTO_PAGO/GetAllDocumentoPagoFilters

Searches for existing payment documents using a single free-text search parameter. The business layer (FAC_DOCUMENTO_PAGOBL.Instancia.GetAllFacDocumentoPagoFilters) applies the value in c_dato against searchable columns such as document code and description. Request body — FAC_DOCUMENTO_PAGORequest

c_dato

string

required

Free-text search string. The business layer queries this value against the document code (c_codigo) and description (t_descripcion) columns. Pass an empty string "" to retrieve all records without filtering.

Example request

curl -X POST https://{host}/api/FAC_DOCUMENTO_PAGO/GetAllDocumentoPagoFilters \
  -H "Content-Type: application/json" \
  -d '{ "c_dato": "BOLETA" }'

Example response

{
  "Success": true,
  "Warning": false,
  "Message": null,
  "Data": [
    {
      "id_documento_pago": 1,
      "c_codigo": "BV",
      "t_descripcion": "Boleta de Venta"
    },
    {
      "id_documento_pago": 2,
      "c_codigo": "FA",
      "t_descripcion": "Factura Electrónica"
    }
  ]
}

Response fields — FAC_DOCUMENTO_PAGODTO

id_documento_pago

integer

Auto-generated primary key of the payment document type.

c_codigo

string

Short alphanumeric code for the document type (e.g., "BV" for Boleta de Venta, "FA" for Factura).

t_descripcion

string

Full descriptive name of the payment document type.

POST /api/FAC_DOCUMENTO_PAGO/addComprobante

Creates a new comprobante de pago (billing document) together with all its line items in a single transactional operation. The request body consists of a document header (FAC_COMPROBANTEReqDTO) with an embedded list of detail lines (DetalleComprobante). The business layer calls FAC_DOCUMENTO_PAGOBL.Instancia.Add2, which persists the header and all detail rows atomically.

Before inserting, the controller calls PruebaBL.Instancia.Exists("0") as a system-level guard check. Under normal operating conditions this check returns false and the insert proceeds. If it returns true the comprobante is not saved and the response contains Warning: true with Message: "Ya existe el registro". Contact your system administrator if you encounter this response unexpectedly.

Request body — FAC_COMPROBANTEReqDTO

Show Header fields

id_documento_pago

integer

required

Document type ID from FAC_DOCUMENTO_PAGO (e.g., 1 for Boleta de Venta, 2 for Factura).

id_atencion

integer

required

ID of the patient attendance record to which this comprobante is linked. Each attendance may have at most one comprobante.

id_tipo_documento

integer

required

Billing party document type ID (e.g., DNI, RUC) for the payer.

c_numero_de_documento

string

required

Billing party document number (DNI or RUC of the patient or company being invoiced).

t_direccion

string

Billing address of the payer.

t_paciente

string

required

Full name of the patient or billing entity as it should appear on the comprobante.

d_fecha_emis

string (ISO 8601 datetime)

required

Emission date and time of the comprobante (e.g., "2024-06-15T10:30:00").

id_condicion_pago

integer

required

Payment condition ID (e.g., contado/cash vs. crédito/credit).

id_moneda

integer

required

Currency ID from CVN_MONEDA (e.g., 1 for PEN, 2 for USD).

n_porcen_igv

integer

required

IGV (VAT) percentage to apply. In Peru the standard rate is 18.

n_porcen_descu

integer

Global discount percentage applied to the document total.

n_total_bruto

decimal

required

Total gross amount before any discounts or taxes.

n_total_descuento

decimal

Total monetary discount amount applied.

n_total_anticipo

decimal

Any advance payment (anticipo) already received for this attendance.

n_total_gravada

decimal

required

Total taxable (gravada) base amount subject to IGV.

n_total_no_gravada

decimal

Total non-taxable (no gravada) amount (e.g., insurance-covered portion exempt from IGV).

n_total_icbper

decimal

ICBPER (Impuesto al Consumo de Bolsas de Plástico) amount, if applicable.

n_total_impuesto

decimal

required

Total tax (IGV) amount calculated on the taxable base.

n_total_neto

decimal

required

Final net payable amount (n_total_gravada + n_total_no_gravada + n_total_impuesto - n_total_descuento - n_total_anticipo).

t_observacion

string

Optional free-text observation printed on the comprobante.

id_user_registro

integer

required

Numeric ID of the user registering this comprobante (audit + logging field).

Show DetalleComprobante — line item array

DetalleComprobante is a required array (List<FAC_COMPROBANTE_DetalleDTO>) containing at least one item. Each element represents a single service or procedure rendered during the attendance.

DetalleComprobante[].id_tarifario_segus

integer

required

Tariff item ID from CVN_TARIFARIO_SEGUS that identifies the service or procedure.

DetalleComprobante[].t_tarifario_segus

string

Human-readable name of the tariff item as it should appear on the line.

DetalleComprobante[].c_codigo_segus

string

SEGUS code of the tariff item.

DetalleComprobante[].id_clasificacion_segus

integer

SEGUS classification ID for the line item.

DetalleComprobante[].t_clasificacion_segus

string

Resolved SEGUS classification name (denormalized for display on the comprobante).

DetalleComprobante[].n_precio

decimal

required

Unit price of the service in the comprobante currency.

DetalleComprobante[].n_cantidad

decimal

required

Quantity of units rendered (e.g., 1.00 for a single consultation, 3.00 for three sessions).

DetalleComprobante[].n_subtotal

decimal

required

Subtotal before line discount (n_precio × n_cantidad).

DetalleComprobante[].n_descuento

decimal

Line-level monetary discount applied to this item.

DetalleComprobante[].n_total

decimal

required

Net line total after discount (n_subtotal - n_descuento).

Full example request

curl -X POST https://{host}/api/FAC_DOCUMENTO_PAGO/addComprobante \
  -H "Content-Type: application/json" \
  -d '{
    "id_documento_pago": 1,
    "id_atencion": 1042,
    "id_tipo_documento": 1,
    "c_numero_de_documento": "45678901",
    "t_direccion": "Av. La Marina 2000, San Miguel, Lima",
    "t_paciente": "García López, María Elena",
    "d_fecha_emis": "2024-06-15T10:30:00",
    "id_condicion_pago": 1,
    "id_moneda": 1,
    "n_porcen_igv": 18,
    "n_porcen_descu": 0,
    "n_total_bruto": 169.49,
    "n_total_descuento": 0.00,
    "n_total_anticipo": 0.00,
    "n_total_gravada": 169.49,
    "n_total_no_gravada": 0.00,
    "n_total_icbper": 0.00,
    "n_total_impuesto": 30.51,
    "n_total_neto": 200.00,
    "t_observacion": "Pago al contado",
    "id_user_registro": 7,
    "DetalleComprobante": [
      {
        "id_tarifario_segus": 10,
        "t_tarifario_segus": "Consulta Médica General",
        "c_codigo_segus": "TAR-CONS-001",
        "id_clasificacion_segus": 2,
        "t_clasificacion_segus": "Consultas",
        "n_precio": 85.00,
        "n_cantidad": 1.00,
        "n_subtotal": 85.00,
        "n_descuento": 0.00,
        "n_total": 85.00
      },
      {
        "id_tarifario_segus": 45,
        "t_tarifario_segus": "Ecografía Abdominal",
        "c_codigo_segus": "TAR-ECOG-001",
        "id_clasificacion_segus": 3,
        "t_clasificacion_segus": "Procedimientos de Diagnóstico",
        "n_precio": 84.49,
        "n_cantidad": 1.00,
        "n_subtotal": 84.49,
        "n_descuento": 0.00,
        "n_total": 84.49
      }
    ]
  }'

Example response (success)

{
  "Success": true,
  "Warning": false,
  "Message": "Registro Satisfactorio",
  "Data": null
}

Example response (business rule block)

{
  "Success": true,
  "Warning": true,
  "Message": "Ya existe el registro",
  "Data": null
}

Example response (business logic failure from Add2)

{
  "Success": true,
  "Warning": true,
  "Message": "No se pudo registrar el comprobante. Verifique los datos e intente nuevamente.",
  "Data": null
}

When Add2 returns a non-positive result, the Message is taken directly from resultado.Item2 — the second element of the tuple returned by the business layer. This message may contain a descriptive error from the stored procedure or business rule violated.

The comprobante follows a classic header / detail (cabecera / detalle) pattern common in Peruvian billing systems:

FAC_COMPROBANTEReqDTO  ←  document header (1 record)
  └── DetalleComprobante[]  ←  line items (1..N records)

The entire structure is submitted in a single POST call and persisted atomically by the Add2 business method. This means:

If any line item fails validation, no part of the comprobante is saved.
The header totals (n_total_bruto, n_total_neto, etc.) must be pre-calculated by the client and match the sum of line item totals — the API does not recalculate totals server-side.
Each line item must reference a valid id_tarifario_segus from the tariff catalog.

Mismatches between the header totals and the sum of DetalleComprobante[].n_total values will not cause a validation error at the API layer, but may produce incorrect comprobantes and reporting discrepancies. Always calculate and verify totals before submitting.

Complete Field Reference

FAC_DOCUMENTO_PAGODTO (search result)

id_documento_pago

integer

Primary key of the payment document type record.

c_codigo

string

Document type code (e.g., "BV", "FA", "RH").

t_descripcion

string

Full name of the document type.

FAC_COMPROBANTEReqDTO — Header summary

Field	Type	Required	Description
`id_documento_pago`	integer	✅	Document type ID.
`id_atencion`	integer	✅	Attendance ID to bill.
`id_tipo_documento`	integer	✅	Payer’s document type (DNI, RUC, etc.).
`c_numero_de_documento`	string	✅	Payer’s document number.
`t_paciente`	string	✅	Payer / patient name for the comprobante header.
`d_fecha_emis`	datetime	✅	Emission date/time.
`id_condicion_pago`	integer	✅	Payment condition (cash / credit).
`id_moneda`	integer	✅	Currency (`CVN_MONEDA`).
`n_porcen_igv`	integer	✅	IGV percentage (standard: `18`).
`n_total_bruto`	decimal	✅	Gross total before discounts and taxes.
`n_total_gravada`	decimal	✅	Taxable base amount.
`n_total_impuesto`	decimal	✅	Total IGV amount.
`n_total_neto`	decimal	✅	Final net payable amount.
`id_user_registro`	integer	✅	Registering user ID (audit).
`DetalleComprobante`	array	✅	Array of line item objects (see below).
`t_direccion`	string		Payer address.
`t_observacion`	string		Free-text note for the comprobante.
`n_porcen_descu`	integer		Global discount percentage.
`n_total_descuento`	decimal		Total discount monetary amount.
`n_total_anticipo`	decimal		Advance payment already received.
`n_total_no_gravada`	decimal		Non-taxable amount.
`n_total_icbper`	decimal		ICBPER tax amount (plastic bag tax).

FAC_COMPROBANTE_DetalleDTO — Line item summary

Field	Type	Required	Description
`id_tarifario_segus`	integer	✅	Tariff item ID from `CVN_TARIFARIO_SEGUS`.
`n_precio`	decimal	✅	Unit price.
`n_cantidad`	decimal	✅	Quantity rendered.
`n_subtotal`	decimal	✅	Subtotal before discount (`precio × cantidad`).
`n_total`	decimal	✅	Net line total after discount.
`t_tarifario_segus`	string		Tariff item display name.
`c_codigo_segus`	string		SEGUS code of the tariff item.
`id_clasificacion_segus`	integer		SEGUS classification ID.
`t_clasificacion_segus`	string		SEGUS classification name (denormalized).
`n_descuento`	decimal		Line-level monetary discount.

The Response and Response_t fields on FAC_COMPROBANTEReqDTO are output-only fields populated by the business layer after processing. When submitting a new comprobante, you can include them with default values (0 / "") or omit them entirely.

Security

Patient Management

Clinical Catalog

Insurance & Billing

Pharmacy

Accounting

Payment Document Endpoints — FAC_DOCUMENTO_PAGO API

Common Response Envelope

Endpoints

POST /api/FAC_DOCUMENTO_PAGO/GetAllDocumentoPagoFilters

POST /api/FAC_DOCUMENTO_PAGO/addComprobante

Header + Detail Pattern

Complete Field Reference

FAC_DOCUMENTO_PAGODTO (search result)

FAC_COMPROBANTEReqDTO — Header summary

FAC_COMPROBANTE_DetalleDTO — Line item summary

Build docs developers (and LLMs) love

Security

Patient Management

Clinical Catalog

Insurance & Billing

Pharmacy

Accounting

Documentation Index

​Common Response Envelope

​Endpoints

​POST /api/FAC_DOCUMENTO_PAGO/GetAllDocumentoPagoFilters

​POST /api/FAC_DOCUMENTO_PAGO/addComprobante

​Header + Detail Pattern

​Complete Field Reference

​FAC_DOCUMENTO_PAGODTO (search result)

​FAC_COMPROBANTEReqDTO — Header summary

​FAC_COMPROBANTE_DetalleDTO — Line item summary

Build docs developers (and LLMs) love

Common Response Envelope

Endpoints

POST /api/FAC_DOCUMENTO_PAGO/GetAllDocumentoPagoFilters

POST /api/FAC_DOCUMENTO_PAGO/addComprobante

Header + Detail Pattern

Complete Field Reference

FAC_DOCUMENTO_PAGODTO (search result)

FAC_COMPROBANTEReqDTO — Header summary

FAC_COMPROBANTE_DetalleDTO — Line item summary