create_invoice() — fastapi Function Reference

Architecture documentation for the create_invoice() function in tutorial001_py310.py from the fastapi codebase.

Function python FastAPI Responses

Entity Profile

FastAPI→ Responses→ create_invoice() — fastapi Function Reference

Dependency Diagram

graph TD
  0cea589f_1cbe_b09d_d45a_fc3630b3f2e3["create_invoice()"]
  afcb769f_589f_e309_388e_f8687057b2df["tutorial001_py310.py"]
  0cea589f_1cbe_b09d_d45a_fc3630b3f2e3 -->|defined in| afcb769f_589f_e309_388e_f8687057b2df
  style 0cea589f_1cbe_b09d_d45a_fc3630b3f2e3 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

docs_src/openapi_callbacks/tutorial001_py310.py lines 34–51

def create_invoice(invoice: Invoice, callback_url: HttpUrl | None = None):
    """
    Create an invoice.

    This will (let's imagine) let the API user (some external developer) create an
    invoice.

    And this path operation will:

    * Send the invoice to the client.
    * Collect the money from the client.
    * Send a notification back to the API user (the external developer), as a callback.
        * At this point is that the API will somehow send a POST request to the
            external API with the notification of the invoice event
            (e.g. "payment successful").
    """
    # Send the invoice, collect the money, send the notification (the callback)
    return {"msg": "Invoice received"}