.. AUTO-GENERATED FILE. DO NOT EDIT.

sales-invoices-series-by-id-delete
==================================

Source
------

- Repository: ``jef-systems/jef-sales-invoices-backend``
- Source Run ID: ``24009064841``
- Source SHA: ``92f7d367e27d34a8feb772a445da302f33a286af``
- Module: ``sales-invoices``
- Documentation Scope: ``async``
- Lambda: ``jef-sales-invoices-delete-58``

Endpoint
--------

- API Name: ``jef-sales-invoices``
- Action Name: ``delete``
- Method: ``DELETE``
- Scope Label: ``Async``
- Resource Path: ``/sales-invoices-series-by-id-delete``
- Complete Endpoint: ``https://f85p4su499.execute-api.ap-southeast-1.amazonaws.com/prod/sales-invoices-series-by-id-delete``
- Lambda ARN: ``arn:aws:lambda:ap-southeast-1:246715082475:function:jef-sales-invoices-delete-58``
- curl payload mode: ``json_body``

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

.. code-block:: text

   Function: jef-sales-invoices-delete-58
   API Name: jef-sales-invoices
   Action: delete
   Method: DELETE
   Resource Path: /sales-invoices-series-by-id-delete
   
   Payload:
   - series_id: series-uuid
   
   Response:
   - ok: true
   - job_id: job-uuid
   - status: PENDING

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

.. code-block:: json

   {
     "series_id": "series-uuid"
   }

Response
--------

.. code-block:: json

   {
     "ok": "true",
     "job_id": "job-uuid",
     "status": "PENDING"
   }

CMD curl
--------

.. code-block:: text

   curl -X DELETE "https://f85p4su499.execute-api.ap-southeast-1.amazonaws.com/prod/sales-invoices-series-by-id-delete" -H "Content-Type: application/json" --data-raw "{\"series_id\": \"series-uuid\"}"

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

.. code-block:: text

   curl.exe -X DELETE "https://f85p4su499.execute-api.ap-southeast-1.amazonaws.com/prod/sales-invoices-series-by-id-delete" -H "Content-Type: application/json" --data-raw '{"series_id": "series-uuid"}'