Inventario — BestDoctorsRD API

GET/v1/inventory/movements

List inventory movement history

Parámetros

Nombre	En	Tipo	Obl.
`productId`	query	string o nulo	No
`movementType`	query	string o nulo	No
`dateFrom`	query	string (date-time) o nulo	No
`dateTo`	query	string (date-time) o nulo	No

Respuestas

Código	Descripción	Devuelve
200	Respuesta correcta	lista de MovementOut
422	Error de validación	HTTPValidationError

POST/v1/inventory/movements

Register an inventory movement

Cuerpo obligatorio `MovementCreateIn`

Campo	Tipo	Obl.
`productId`	string	Sí
`fromWarehouseId`	string o nulo	No
`toWarehouseId`	string o nulo	No
`movementType`	"PURCHASE_IN" \| "ADJUSTMENT_IN" \| "RETURN_IN" \| "PATIENT_CONSUMPTION_OUT" \| "SALE_OUT" \| "EXPIRY_OUT" \| "DAMAGE_OUT" \| "TRANSFER" \| "ADJUSTMENT_OUT"	Sí
`quantity`	number	Sí
`cost`	number	No
`reason`	string	Sí
`relatedPatientId`	string o nulo	No

Respuestas

Código	Descripción	Devuelve
201	Respuesta correcta	MovementOut
422	Error de validación	HTTPValidationError

curl

curl -X POST "https://api.bestdoctorsrd.com/v1/inventory/movements" \
  -H "Content-Type: application/json" \
  -d '{ "productId": …, "movementType": …, "quantity": …, "reason": … }'

GET/v1/inventory/products

List inventory products

Parámetros

Nombre	En	Tipo	Obl.
`stock_alert`	query	boolean	No

Respuestas

Código	Descripción	Devuelve
200	Respuesta correcta	lista de ProductOut
422	Error de validación	HTTPValidationError

POST/v1/inventory/products

Create an inventory product

Cuerpo obligatorio `ProductCreateIn`

Campo	Tipo	Obl.
`warehouseId`	string	Sí
`code`	string	Sí
`name`	string	Sí
`category`	string	Sí
`productType`	string	Sí
`unit`	string	Sí
`requiresLot`	boolean	No
`requiresExpiry`	boolean	No
`controlled`	boolean	No
`averageCost`	number	No
`salePrice`	number	No
`stock`	number	No
`minStock`	number	No
`maxStock`	number	No
`isActive`	boolean	No

Respuestas

Código	Descripción	Devuelve
201	Respuesta correcta	ProductOut
422	Error de validación	HTTPValidationError

PATCH/v1/inventory/products/{product_id}

Update an inventory product

Parámetros

Nombre	En	Tipo	Obl.
`product_id`	path	string	Sí

Cuerpo obligatorio `ProductPatchIn`

Campo	Tipo	Obl.
`warehouseId`	string o nulo	No
`code`	string o nulo	No
`name`	string o nulo	No
`category`	string o nulo	No
`productType`	string o nulo	No
`unit`	string o nulo	No
`requiresLot`	boolean o nulo	No
`requiresExpiry`	boolean o nulo	No
`controlled`	boolean o nulo	No
`averageCost`	number o nulo	No
`salePrice`	number o nulo	No
`stock`	number o nulo	No
`minStock`	number o nulo	No
`maxStock`	number o nulo	No
`isActive`	boolean o nulo	No

Respuestas

Código	Descripción	Devuelve
200	Respuesta correcta	ProductOut
422	Error de validación	HTTPValidationError

GET/v1/inventory/purchase-orders

List purchase orders for receiving

Parámetros

Nombre	En	Tipo	Obl.
`status`	query	string o nulo	No

Respuestas

Código	Descripción	Devuelve
200	Respuesta correcta	lista de PurchaseOrderOut
422	Error de validación	HTTPValidationError

GET/v1/inventory/receipts

List supplier receipts

Respuestas

Código	Descripción	Devuelve
200	Respuesta correcta	lista de ReceiptOut

POST/v1/inventory/receipts

Receive supplier goods against a purchase order

Cuerpo obligatorio `ReceiptCreateIn`

Campo	Tipo	Obl.
`purchaseOrderId`	string	Sí
`supplierId`	string	Sí
`warehouseId`	string	Sí
`supplierInvoiceRef`	string	Sí
`supplierInvoiceDate`	string (date) o nulo	No
`receivedAt`	string (date-time) o nulo	No
`notes`	string o nulo	No
`lines`	lista de ReceiptLineIn	Sí

Respuestas

Código	Descripción	Devuelve
201	Respuesta correcta	ReceiptOut
422	Error de validación	HTTPValidationError

curl

curl -X POST "https://api.bestdoctorsrd.com/v1/inventory/receipts" \
  -H "Content-Type: application/json" \
  -d '{ "purchaseOrderId": …, "supplierId": …, "warehouseId": …, "supplierInvoiceRef": … }'

GET/v1/inventory/reports/overview

Inventory reporting overview

Parámetros

Nombre	En	Tipo	Obl.
`productId`	query	string o nulo	No
`warehouseId`	query	string o nulo	No
`supplierId`	query	string o nulo	No
`movementType`	query	string o nulo	No
`dateFrom`	query	string (date-time) o nulo	No
`dateTo`	query	string (date-time) o nulo	No

Respuestas

Código	Descripción	Devuelve
200	Respuesta correcta	InventoryReportOut
422	Error de validación	HTTPValidationError

GET/v1/inventory/suppliers

List inventory suppliers

Respuestas

Código	Descripción	Devuelve
200	Respuesta correcta	lista de SupplierOut

POST/v1/inventory/suppliers

Create an inventory supplier

Cuerpo obligatorio `SupplierCreateIn`

Campo	Tipo	Obl.
`taxId`	string o nulo	No
`legalName`	string o nulo	No
`commercialName`	string o nulo	No
`address`	string	Sí
`phone`	string o nulo	No
`email`	string o nulo	No
`primaryContact`	string o nulo	No
`paymentTerms`	string o nulo	No
`suppliedProducts`	lista de string	No
`status`	"ACTIVE" \| "ON_HOLD" \| "INACTIVE"	No

Respuestas

Código	Descripción	Devuelve
201	Respuesta correcta	SupplierOut
422	Error de validación	HTTPValidationError

PATCH/v1/inventory/suppliers/{supplier_id}

Update an inventory supplier

Parámetros

Nombre	En	Tipo	Obl.
`supplier_id`	path	string	Sí

Cuerpo obligatorio `SupplierPatchIn`

Campo	Tipo	Obl.
`taxId`	string o nulo	No
`legalName`	string o nulo	No
`commercialName`	string o nulo	No
`address`	string o nulo	No
`phone`	string o nulo	No
`email`	string o nulo	No
`primaryContact`	string o nulo	No
`paymentTerms`	string o nulo	No
`suppliedProducts`	lista de string o nulo	No
`status`	"ACTIVE" \| "ON_HOLD" \| "INACTIVE" o nulo	No

Respuestas

Código	Descripción	Devuelve
200	Respuesta correcta	SupplierOut
422	Error de validación	HTTPValidationError

GET/v1/inventory/warehouses

List inventory warehouses

Respuestas

Código	Descripción	Devuelve
200	Respuesta correcta	lista de WarehouseOut

POST/v1/inventory/warehouses

Create an inventory warehouse

Cuerpo obligatorio `WarehouseCreateIn`

Campo	Tipo	Obl.
`branchId`	string	Sí
`name`	string	Sí
`warehouseType`	string	Sí
`isPrimary`	boolean	No
`status`	string	No

Respuestas

Código	Descripción	Devuelve
201	Respuesta correcta	WarehouseOut
422	Error de validación	HTTPValidationError

PATCH/v1/inventory/warehouses/{warehouse_id}

Update an inventory warehouse

Parámetros

Nombre	En	Tipo	Obl.
`warehouse_id`	path	string	Sí

Cuerpo obligatorio `WarehousePatchIn`

Campo	Tipo	Obl.
`branchId`	string o nulo	No
`isPrimary`	boolean o nulo	No
`name`	string o nulo	No
`warehouseType`	string o nulo	No
`status`	string o nulo	No

Respuestas

Código	Descripción	Devuelve
200	Respuesta correcta	WarehouseOut
422	Error de validación	HTTPValidationError

List inventory movement history

Parámetros

Respuestas

Register an inventory movement

Cuerpo obligatorio MovementCreateIn

Respuestas

List inventory products

Parámetros

Respuestas

Create an inventory product

Cuerpo obligatorio ProductCreateIn

Respuestas

Update an inventory product

Parámetros

Cuerpo obligatorio ProductPatchIn

Respuestas

List purchase orders for receiving

Parámetros

Respuestas

List supplier receipts

Respuestas

Receive supplier goods against a purchase order

Cuerpo obligatorio ReceiptCreateIn

Respuestas

Inventory reporting overview

Parámetros

Respuestas

List inventory suppliers

Respuestas

Create an inventory supplier

Cuerpo obligatorio SupplierCreateIn

Respuestas

Update an inventory supplier

Parámetros

Cuerpo obligatorio SupplierPatchIn

Respuestas

List inventory warehouses

Respuestas

Create an inventory warehouse

Cuerpo obligatorio WarehouseCreateIn

Respuestas

Update an inventory warehouse

Parámetros

Cuerpo obligatorio WarehousePatchIn

Respuestas

Cuerpo obligatorio `MovementCreateIn`

Cuerpo obligatorio `ProductCreateIn`

Cuerpo obligatorio `ProductPatchIn`

Cuerpo obligatorio `ReceiptCreateIn`

Cuerpo obligatorio `SupplierCreateIn`

Cuerpo obligatorio `SupplierPatchIn`

Cuerpo obligatorio `WarehouseCreateIn`

Cuerpo obligatorio `WarehousePatchIn`