Recurso

Facturación

19 operaciones · base https://api.bestdoctorsrd.com

GET/v1/billing/admissions

List Billing Admissions

Parámetros

NombreEnTipoObl.
patientIdquerystring o nuloNo
statusquerystring o nuloNo
tenantIdquerystring o nuloNo

Respuestas

CódigoDescripciónDevuelve
200Respuesta correctalista de BillingAdmissionOptionOut
422Error de validaciónHTTPValidationError
GET/v1/billing/admissions/{admission_id}

Get Billing Admission

Parámetros

NombreEnTipoObl.
admission_idpathstring
tenantIdquerystring o nuloNo

Respuestas

CódigoDescripciónDevuelve
200Respuesta correctaBillingAdmissionOptionOut
422Error de validaciónHTTPValidationError
GET/v1/billing/charges

List Legacy Billing Charges

Respuestas

CódigoDescripciónDevuelve
200Respuesta correctaobjeto
POST/v1/billing/charges

Create Legacy Billing Charge

Respuestas

CódigoDescripciónDevuelve
201Respuesta correctaobjeto
GET/v1/billing/patients

List Billing Patients

Parámetros

NombreEnTipoObl.
qquerystring o nuloNo
limitqueryintegerNo
tenantIdquerystring o nuloNo

Respuestas

CódigoDescripciónDevuelve
200Respuesta correctalista de BillingPatientOptionOut
422Error de validaciónHTTPValidationError
GET/v1/billing/unbilled-visits

List Unbilled Visits

Visitas atendidas sin NINGÚN cargo ligado — la worklist que cierra la fuga "atendido sin facturar". Cubre dos tipos: (1) encuentros ambulatorios COMPLETED sin cargo por encounter ni por su cita, y (2) internamientos DISCHARGED (dados de alta) sin cargo por admisión. Al completar/dar de alta no se crea cargo, así que una atendida-nunca-facturada no aparece en /charges (no hay fila) y, una vez pasa el día, se pierde. Read-only, sin efectos secundarios; ventana en días y tenant-scoped.

Parámetros

NombreEnTipoObl.
daysqueryintegerNo
tenantIdquerystring o nuloNo

Respuestas

CódigoDescripciónDevuelve
200Respuesta correctalista de UnbilledVisitOut
422Error de validaciónHTTPValidationError
GET/v1/invoice-ncf-sequences

List Invoice Ncf Sequences

Parámetros

NombreEnTipoObl.
branchIdquerystring o nuloNo
ncfTypequerystring o nuloNo
activequeryboolean o nuloNo
tenantIdquerystring o nuloNo

Respuestas

CódigoDescripciónDevuelve
200Respuesta correctalista de InvoiceNcfSequenceOut
422Error de validaciónHTTPValidationError
POST/v1/invoice-ncf-sequences

Create Invoice Ncf Sequence

Parámetros

NombreEnTipoObl.
tenantIdquerystring o nuloNo

Cuerpo obligatorio InvoiceNcfSequenceCreateIn

CampoTipoObl.
branchIdstring o nuloNo
ncfTypestring
prefixstring
rangeStartinteger
rangeEndinteger
expiresAtstring (date-time) o nuloNo
isActivebooleanNo

Respuestas

CódigoDescripciónDevuelve
201Respuesta correctaInvoiceNcfSequenceOut
422Error de validaciónHTTPValidationError
GET/v1/invoices

List Invoices

Parámetros

NombreEnTipoObl.
patientIdquerystring o nuloNo
statusquerystring o nuloNo
ncfTypequerystring o nuloNo
fromDatequerystring (date-time) o nuloNo
toDatequerystring (date-time) o nuloNo
includePaidDatequerybooleanNo
searchquerystring o nuloNo
tenantIdquerystring o nuloNo

Respuestas

CódigoDescripciónDevuelve
200Respuesta correctalista de InvoiceOut
422Error de validaciónHTTPValidationError
POST/v1/invoices

Create Invoice

Parámetros

NombreEnTipoObl.
tenantIdquerystring o nuloNo

Cuerpo obligatorio InvoiceCreateIn

CampoTipoObl.
patientIdstring
chargeIdslista de stringNo
itemslista de PatientChargeCreateInNo
ncfTypestring o nuloNo
ncfNumberstring o nuloNo
paymentMethodstring o nuloNo

Respuestas

CódigoDescripciónDevuelve
201Respuesta correctaInvoiceOut
422Error de validaciónHTTPValidationError
GET/v1/invoices/{invoice_id}

Get Invoice

Parámetros

NombreEnTipoObl.
invoice_idpathstring

Respuestas

CódigoDescripciónDevuelve
200Respuesta correctaInvoiceOut
422Error de validaciónHTTPValidationError
PATCH/v1/invoices/{invoice_id}

Update Invoice

Parámetros

NombreEnTipoObl.
invoice_idpathstring

Cuerpo obligatorio InvoiceUpdateIn

CampoTipoObl.
ncfTypestring o nuloNo
ncfNumberstring o nuloNo
paymentMethodstring o nuloNo

Respuestas

CódigoDescripciónDevuelve
200Respuesta correctaInvoiceOut
422Error de validaciónHTTPValidationError
GET/v1/invoices/{invoice_id}/credit-notes

List Invoice Credit Notes

Parámetros

NombreEnTipoObl.
invoice_idpathstring
tenantIdquerystring o nuloNo

Respuestas

CódigoDescripciónDevuelve
200Respuesta correctalista de CreditNoteOut
422Error de validaciónHTTPValidationError
POST/v1/invoices/{invoice_id}/credit-notes

Emitir nota de credito (B04) o debito (B03) contra una factura

Parámetros

NombreEnTipoObl.
invoice_idpathstring
tenantIdquerystring o nuloNo

Cuerpo obligatorio CreditNoteIn

CampoTipoObl.
noteType"CREDIT" | "DEBIT"
amountnumber
reasonstring

Respuestas

CódigoDescripciónDevuelve
201Respuesta correctaCreditNoteOut
422Error de validaciónHTTPValidationError
PATCH/v1/invoices/{invoice_id}/status

Update Invoice Status

Parámetros

NombreEnTipoObl.
invoice_idpathstring

Cuerpo obligatorio InvoiceStatusIn

CampoTipoObl.
status"PAID" | "VOIDED"
voidReasonstring o nuloNo

Respuestas

CódigoDescripciónDevuelve
200Respuesta correctaInvoiceOut
422Error de validaciónHTTPValidationError
GET/v1/patient-charges

List Patient Charges

Parámetros

NombreEnTipoObl.
admissionIdquerystring o nuloNo
patientIdquerystring o nuloNo
doctorIdquerystring o nuloNo
statusquerystring o nuloNo
sourceModulequerystring o nuloNo
areaquerystring o nuloNo
encounterIdquerystring o nuloNo
appointmentIdquerystring o nuloNo
fromDatequerystring (date-time) o nuloNo
toDatequerystring (date-time) o nuloNo
tenantIdquerystring o nuloNo

Respuestas

CódigoDescripciónDevuelve
200Respuesta correctalista de PatientChargeOut
422Error de validaciónHTTPValidationError
POST/v1/patient-charges

Create Patient Charge

Parámetros

NombreEnTipoObl.
tenantIdquerystring o nuloNo

Cuerpo obligatorio PatientChargeCreateIn

CampoTipoObl.
patientIdstring
branchIdstring o nuloNo
doctorIdstring o nuloNo
admissionIdstring o nuloNo
appointmentIdstring o nuloNo
encounterIdstring o nuloNo
clinicalRecordIdstring o nuloNo
invoiceIdstring o nuloNo
areastring o nuloNo
sourceModulestring
originEntityTypestring o nuloNo
originEntityIdstring o nuloNo
originEventIdstring o nuloNo
idempotencyKeystring o nuloNo
serviceCodestring
descriptionstringNo
currencystringNo
quantitynumber
unitPricenumberNo
discountnumberNo
insuranceCovernumberNo
insurancePlanIdstring o nuloNo
coverageEstimateIdstring o nuloNo

Respuestas

CódigoDescripciónDevuelve
201Respuesta correctaPatientChargeOut
422Error de validaciónHTTPValidationError
GET/v1/patient-charges/{charge_id}/audit

Get Patient Charge Audit

Parámetros

NombreEnTipoObl.
charge_idpathstring
tenantIdquerystring o nuloNo

Respuestas

CódigoDescripciónDevuelve
200Respuesta correctaChargeAuditTrailOut
422Error de validaciónHTTPValidationError
PATCH/v1/patient-charges/{charge_id}/status

Update Patient Charge Status

Parámetros

NombreEnTipoObl.
charge_idpathstring

Cuerpo obligatorio PatientChargeStatusIn

CampoTipoObl.
status"INSURANCE_COVERED" | "PAID" | "VOIDED"
auditReasonstring o nuloNo

Respuestas

CódigoDescripciónDevuelve
200Respuesta correctaPatientChargeOut
422Error de validaciónHTTPValidationError