Recurso

Caja

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

GET/v1/cashier/deposits

List Cashier Deposits

Parámetros

NombreEnTipoObl.
branchIdquerystring o nuloNo
patientIdquerystring o nuloNo
admissionIdquerystring o nuloNo
tenantIdquerystring o nuloNo

Respuestas

CódigoDescripciónDevuelve
200Respuesta correctalista de CashierDepositOut
422Error de validaciónHTTPValidationError
POST/v1/cashier/deposits/{deposit_id}/apply

Apply Cashier Deposit

Parámetros

NombreEnTipoObl.
deposit_idpathstring
tenantIdquerystring o nuloNo

Cuerpo obligatorio CashierDepositApplyIn

CampoTipoObl.
invoiceIdstring
amountnumber o nuloNo

Respuestas

CódigoDescripciónDevuelve
201Respuesta correctaCashierTransactionOut
422Error de validaciónHTTPValidationError
POST/v1/cashier/payments

Create Cashier Payment

Parámetros

NombreEnTipoObl.
tenantIdquerystring o nuloNo

Cuerpo obligatorio CashierPaymentCreateIn

CampoTipoObl.
targetType"INVOICE" | "ADMISSION" | "DEPOSIT"
amountnumber
method"CASH" | "CARD" | "TRANSFER" | "CHECK" | "INSURANCE"
payerNamestring
referencestring o nuloNo
invoiceIdstring o nuloNo
admissionIdstring o nuloNo
patientIdstring o nuloNo
depositAmountnumber o nuloNo
kind"PAYMENT" | "DEPOSIT" | "REFUND" | "REVERSAL"No
originalPaymentIdstring o nuloNo
reasonstring o nuloNo
approverUserIdstring o nuloNo
beneficiaryNamestring o nuloNo
evidenceUrlstring o nuloNo

Respuestas

CódigoDescripciónDevuelve
201Respuesta correctaCashierTransactionOut
422Error de validaciónHTTPValidationError
GET/v1/cashier/refunds

List Cashier Refunds

Parámetros

NombreEnTipoObl.
branchIdquerystring o nuloNo
reasonquerystring o nuloNo
approverUserIdquerystring o nuloNo
targetTypequerystring o nuloNo
targetIdquerystring o nuloNo
searchquerystring o nuloNo
dateFromquerystring (date-time) o nuloNo
dateToquerystring (date-time) o nuloNo
tenantIdquerystring o nuloNo

Respuestas

CódigoDescripciónDevuelve
200Respuesta correctalista de CashierTransactionOut
422Error de validaciónHTTPValidationError
GET/v1/cashier/refunds/summary

Summarize Cashier Refunds

Parámetros

NombreEnTipoObl.
branchIdquerystring o nuloNo
reasonquerystring o nuloNo
approverUserIdquerystring o nuloNo
dateFromquerystring (date-time) o nuloNo
dateToquerystring (date-time) o nuloNo
tenantIdquerystring o nuloNo

Respuestas

CódigoDescripciónDevuelve
200Respuesta correctaCashierRefundSummaryOut
422Error de validaciónHTTPValidationError
GET/v1/cashier/refunds/{refund_id}/document

Get Cashier Refund Document

Parámetros

NombreEnTipoObl.
refund_idpathstring
tenantIdquerystring o nuloNo

Respuestas

CódigoDescripciónDevuelve
200Respuesta correctaCashierRefundDocumentOut
422Error de validaciónHTTPValidationError
GET/v1/cashier/shifts

List Cashier Shifts

Parámetros

NombreEnTipoObl.
branchIdquerystring o nuloNo
statusquerystring o nuloNo
cashierUserIdquerystring o nuloNo
tenantIdquerystring o nuloNo

Respuestas

CódigoDescripciónDevuelve
200Respuesta correctalista de CashierShiftOut
422Error de validaciónHTTPValidationError
POST/v1/cashier/shifts

Open Cashier Shift

Parámetros

NombreEnTipoObl.
tenantIdquerystring o nuloNo

Cuerpo obligatorio CashierShiftOpenIn

CampoTipoObl.
branchIdstring o integer o nullNo

Respuestas

CódigoDescripciónDevuelve
201Respuesta correctaCashierShiftOut
422Error de validaciónHTTPValidationError
PATCH/v1/cashier/shifts/{shift_id}/close

Close Cashier Shift

Parámetros

NombreEnTipoObl.
shift_idpathstring
tenantIdquerystring o nuloNo

Cuerpo obligatorio CashierShiftCloseIn

CampoTipoObl.
actualCashnumberNo
actualCardnumberNo
actualTransfernumberNo
actualChecknumberNo
actualInsurancenumberNo
closingReasonstring o nuloNo
approvedByUserIdstring o nuloNo

Respuestas

CódigoDescripciónDevuelve
200Respuesta correctaCashierShiftOut
422Error de validaciónHTTPValidationError
GET/v1/cashier/shifts/{shift_id}/transactions

List Cashier Shift Transactions

Parámetros

NombreEnTipoObl.
shift_idpathstring
tenantIdquerystring o nuloNo

Respuestas

CódigoDescripciónDevuelve
200Respuesta correctalista de CashierTransactionOut
422Error de validaciónHTTPValidationError
GET/v1/cashier/transactions

List Cashier Transactions

Parámetros

NombreEnTipoObl.
branchIdquerystring o nuloNo
kindquerystring o nuloNo
targetTypequerystring o nuloNo
searchquerystring o nuloNo
reasonquerystring o nuloNo
referencequerystring o nuloNo
approverUserIdquerystring o nuloNo
payerNamequerystring o nuloNo
dateFromquerystring (date-time) o nuloNo
dateToquerystring (date-time) o nuloNo
tenantIdquerystring o nuloNo

Respuestas

CódigoDescripciónDevuelve
200Respuesta correctalista de CashierTransactionOut
422Error de validaciónHTTPValidationError