> ## Documentation Index
> Fetch the complete documentation index at: https://docs.upwell.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Quickstart

> Get started with Upwell in 5 simple steps

## Getting Started with Upwell

Follow these steps to set up your Upwell account and start processing carrier invoices.

### Initial Setup

<AccordionGroup>
  <Accordion icon="user" title="1. Login to Upwell">
    Use the email address provided by your account manager to access your Upwell account.
    If you haven't received your login credentials, please contact your account manager.
  </Accordion>

  <Accordion icon="gears" title="2. Configure TMS Integration">
    Navigate to the Integrations page to set up your Transportation Management System (TMS) integration:

    1. Click on "Integrations" in the main navigation
    2. Select your TMS provider
    3. Follow the provider-specific configuration steps
    4. Test the connection to ensure proper data flow
  </Accordion>

  <Accordion icon="truck" title="3. Setup Shipper Portal Integrations">
    Configure your shipper portal connections to enable automated rate validation:

    1. Go to the Shipper Portal section
    2. Add your carrier credentials
    3. Verify the connection for each carrier
  </Accordion>
</AccordionGroup>

### Final Configuration

<AccordionGroup>
  <Accordion icon="envelope" title="4. Configure Inbound Email Settings">
    Set up your email configuration to receive carrier invoices:

    1. Navigate to Email Settings
    2. Configure your dedicated invoice processing email address
    3. Set up any required email filters or rules
  </Accordion>

  <Accordion icon="paper-plane" title="5. Start Processing Invoices">
    Begin sending carrier invoices to your configured email address. The system will automatically:

    * Receive and process incoming invoices
    * Match invoices against shipment data
    * Validate rates and accessorials
    * Flag any discrepancies for review
  </Accordion>
</AccordionGroup>

## For Developers

If you're building a TMS integration or working with the Upwell API directly, start here instead:

<Steps>
  <Step title="Get your API key">
    Your account manager provides an API key. It authenticates every request — send it as `Authorization: YOUR_API_KEY` (no `Bearer` prefix). See [Authentication](/authentication).
  </Step>

  <Step title="Learn the data model">
    Understand the core objects (shipments, invoices, bills, carrier invoices, payments) and how they relate. See [Core concepts & data model](/concepts/data-model).
  </Step>

  <Step title="Sync your foundation data">
    Push customers, carriers, shipments, and bills from your TMS. See [Syncing foundation entities](/api-guides/syncing-foundation-entities).
  </Step>

  <Step title="Build your AP or AR flow">
    Choose your starting point: [Carrier invoice submission (AP)](/api-guides/carrier-invoice-submission), [Customer invoices (AR)](/api-guides/customer-invoices), or [Purchase orders & vendor invoices](/api-guides/purchase-orders-and-vendor-invoices).
  </Step>

  <Step title="Subscribe to webhooks">
    Get notified when invoices are processed, approved, or hit exceptions. See [Outbound webhooks](/api-guides/webhooks).
  </Step>
</Steps>

<Tip>
  Read [Integration patterns](/integration-patterns) for cross-cutting conventions: integer-cents money, the `sourceSystem` / `sourceSystemId` upsert key, the `input` wrapper, and the presigned-upload flow.
</Tip>

## Need Help?

<CardGroup>
  <Card title="Contact Support" icon="headset" href="mailto:support@upwell.com">
    Get help from our support team.
  </Card>

  <Card title="API Reference" icon="code" href="/api-reference/introduction">
    Browse our detailed API documentation.
  </Card>

  <Card title="Troubleshooting" icon="wrench" href="/troubleshooting">
    Find solutions to common issues.
  </Card>

  <Card title="Authentication Guide" icon="key" href="/authentication">
    Learn how to authenticate with the API.
  </Card>
</CardGroup>