.. AUTO-GENERATED FILE. DO NOT EDIT.

hardware-rentals-get-one
========================

Source
------

- Repository: ``jef-systems/jef-hardware-backend``
- Source Run ID: ``25090515545``
- Source SHA: ``444376867c764658b4ed0286bc44ff0ac8c80995``
- Module: ``hardware``
- Documentation Scope: ``get``
- Lambda: ``jef-hardware-get-3``

Endpoint
--------

- API Name: ``jef-hardware``
- Action Name: ``get``
- Method: ``GET``
- Scope Label: ``GET``
- Resource Path: ``/hardware-rentals-get-one``
- Complete Endpoint: ``https://24jo9zrosl.execute-api.ap-southeast-1.amazonaws.com/prod/hardware-rentals-get-one``
- Lambda ARN: ``arn:aws:lambda:ap-southeast-1:246715082475:function:jef-hardware-get-3``
- curl payload mode: ``query_string``

API Gateway Description
-----------------------

.. code-block:: text

   Function: jef-hardware-get-3
   API Name: jef-hardware
   Action: get
   Method: GET
   Resource Path: /hardware-rentals-get-one
   
   Table:
   - table: jef-hardware-rentals
   - operation: get-one
   
   Payload Schema:
   - pk: rental_id
   
   Payload Example:
   - pk: RNT-2026-0001
   
   Response Schema:
   - exists: boolean
   - message: string
   - item: {"entity_number":"string","id":"string","rental_id":"string","order_number":"string","created_at":"string","updated_at":"string","cashier_name":"string","terminal_name":"string","customer_id":"string","customer_code":"string","customer_name":"string","customer_mobile_number":"string","customer_address":"string","customer_government_id_type":"string","customer_government_id_number":"string","deposit":"number","gross_total":"number","total_due":"number","items":[{"line_id":"string","equipment_id":"string","toolbox_number":"string","equipment_name":"string","category":"string","included_items":["string"],"rate_per_day":"number","days":"number","subtotal":"number","qr_value":"string","expected_return_at":"string"}],"expected_return_at":"string","rental_status":"string","print_status":"string","printed_at":"string","printer_device_id":"string","printer_device_name":"string","version":"number","is_deleted":"boolean","sync_status":"string","sync_attempt_count":"number"}

Request Payload
---------------

.. code-block:: json

   {
     "pk": "rental_id"
   }

Response
--------

.. code-block:: json

   {
     "exists": "boolean",
     "message": "string",
     "item": "{\"entity_number\":\"string\",\"id\":\"string\",\"rental_id\":\"string\",\"order_number\":\"string\",\"created_at\":\"string\",\"updated_at\":\"string\",\"cashier_name\":\"string\",\"terminal_name\":\"string\",\"customer_id\":\"string\",\"customer_code\":\"string\",\"customer_name\":\"string\",\"customer_mobile_number\":\"string\",\"customer_address\":\"string\",\"customer_government_id_type\":\"string\",\"customer_government_id_number\":\"string\",\"deposit\":\"number\",\"gross_total\":\"number\",\"total_due\":\"number\",\"items\":[{\"line_id\":\"string\",\"equipment_id\":\"string\",\"toolbox_number\":\"string\",\"equipment_name\":\"string\",\"category\":\"string\",\"included_items\":[\"string\"],\"rate_per_day\":\"number\",\"days\":\"number\",\"subtotal\":\"number\",\"qr_value\":\"string\",\"expected_return_at\":\"string\"}],\"expected_return_at\":\"string\",\"rental_status\":\"string\",\"print_status\":\"string\",\"printed_at\":\"string\",\"printer_device_id\":\"string\",\"printer_device_name\":\"string\",\"version\":\"number\",\"is_deleted\":\"boolean\",\"sync_status\":\"string\",\"sync_attempt_count\":\"number\"}"
   }

CMD curl
--------

.. code-block:: text

   curl "https://24jo9zrosl.execute-api.ap-southeast-1.amazonaws.com/prod/hardware-rentals-get-one?pk=RNT-2026-0001"

PowerShell curl
---------------

.. code-block:: text

   curl.exe "https://24jo9zrosl.execute-api.ap-southeast-1.amazonaws.com/prod/hardware-rentals-get-one?pk=RNT-2026-0001"