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

# Get an advance

> A single advance with balances, paid-in percentage and renewal readiness.



## OpenAPI

````yaml /openapi/public-v1.json get /v1/advances/{id}
openapi: 3.0.0
info:
  title: NextLevel MCA Public API
  description: >-
    REST API for the NextLevel MCA deal platform. Objects flow Businesses →
    People → Deals → Submissions → Offers → Advances.


    **Authentication.** Send `Authorization: Bearer <key>` with an API key
    (`nlmca_live_…`, created in Settings → Developers) or an OAuth access token.
    Keys are scoped to one location.


    **Conventions.** JSON only. Cursor pagination (`limit` ≤ 100, `cursor` from
    `meta.next_cursor`). Every success is `{ data, meta }`; every error is `{
    error: { type, message, code, param, request_id } }`. POST endpoints accept
    `Idempotency-Key` (24h replay). Rate limit 300 requests/min per credential
    (`X-RateLimit-*` headers).


    **Scopes.** Keys with no scopes have all of them. Otherwise:

    - `businesses:read` — Read businesses and their notes, tasks and activity

    - `businesses:write` — Create and update businesses, notes and tasks

    - `people:read` — Read people (contacts and owners)

    - `people:write` — Create and update people

    - `deals:read` — Read deals, submissions and the pipeline

    - `deals:write` — Create and update deals, move stages

    - `documents:read` — Read documents and statement analysis

    - `documents:write` — Upload documents and request documents from merchants

    - `lenders:read` — Read lenders, criteria and lender matches

    - `lenders:write` — Create and update lenders and criteria

    - `submissions:write` — Submit deals to lenders and withdraw submissions

    - `offers:read` — Read offers

    - `offers:write` — Log and update offers, set the primary offer

    - `advances:read` — Read funded advances and renewal flags

    - `advances:write` — Update advances

    - `portal:send` — Generate and send merchant portal links

    - `webhooks:manage` — Manage webhook subscriptions
  version: '1.0'
  contact: {}
servers:
  - url: https://api.nextlevelmca.com
    description: Production
security:
  - bearer: []
tags:
  - name: Businesses
    description: Merchant businesses and their notes, tasks and activity
  - name: People
    description: Contacts and owners. Phone lookups normalise to E.164.
  - name: Deals
    description: Deals, stage moves, renewals and the pipeline
  - name: Documents
    description: Documents, presigned uploads, document requests and statement analysis
  - name: Lenders
    description: Lenders and their criteria
  - name: Lender matches
    description: Criteria-driven lender matching for a deal
  - name: Submissions
    description: Sending deals to lenders
  - name: Offers
    description: Lender offers and the primary offer
  - name: Advances
    description: Funded advances and renewal readiness
  - name: Merchant portal
    description: Magic links for the merchant portal
  - name: Webhooks
    description: Outbound event subscriptions
paths:
  /v1/advances/{id}:
    get:
      tags:
        - Advances
      summary: Get an advance
      description: >-
        A single advance with balances, paid-in percentage and renewal
        readiness.
      operationId: advances_get
      parameters:
        - name: id
          required: true
          in: path
          description: Advance id
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                required:
                  - data
                  - meta
                properties:
                  data:
                    $ref: '#/components/schemas/AdvanceDto'
                  meta:
                    $ref: '#/components/schemas/EmptyMetaDto'
        '401':
          description: Missing, invalid, expired or revoked credential.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelopeDto'
        '403':
          description: Credential lacks the scope, or the role lacks the permission.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelopeDto'
        '404':
          description: Resource not found in this location.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelopeDto'
        '429':
          description: Rate limit exceeded. See `X-RateLimit-*` and `Retry-After`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelopeDto'
      security:
        - bearer: []
components:
  schemas:
    AdvanceDto:
      type: object
      properties:
        id:
          type: string
          description: Advance id.
        deal_id:
          type: string
          description: Deal that was funded.
        business_id:
          type: string
          nullable: true
          description: Business on the deal.
        business_name:
          type: string
          nullable: true
          description: Business name at read time.
        lender_id:
          type: string
          description: Funding lender.
        lender_name:
          type: string
          nullable: true
          description: Lender name at read time.
        offer_id:
          type: string
          nullable: true
          description: Offer the advance was funded from.
        status:
          type: string
          enum:
            - on-track
            - missed-payments
            - defaulted
            - paid-off
          description: Repayment status.
        funded_amount:
          type: number
          description: Amount funded, USD.
        factor_rate:
          type: number
          nullable: true
          description: Factor rate.
        term:
          type: number
          nullable: true
          description: Term length (months unless the offer said otherwise).
        payment_frequency:
          type: string
          nullable: true
          enum:
            - daily
            - weekly
            - bi-weekly
            - monthly
          description: Payment cadence.
        payment_amount:
          type: number
          nullable: true
          description: Amount per payment.
        payback_amount:
          type: number
          description: Total payback, USD.
        paid_amount:
          type: number
          description: Paid so far, USD.
        remaining_balance:
          type: number
          nullable: true
          description: payback_amount − paid_amount.
        percent_paid:
          type: number
          description: paid_amount / payback_amount × 100, one decimal.
        payments_made:
          type: number
          nullable: true
          description: Payments made so far.
        payments_expected:
          type: number
          nullable: true
          description: Payments expected over the term.
        position:
          type: number
          nullable: true
          description: Position (1 = first).
        renewal_ready:
          type: boolean
          description: >-
            True when `percent_paid` ≥ `renewal_threshold` and the advance is
            not paid off.
        renewal_threshold:
          type: number
          description: >-
            Renewal threshold in effect (per-advance override, else the location
            default).
        renewal_threshold_override:
          type: number
          nullable: true
          description: Per-advance override of the renewal threshold, if set.
        funded_at:
          type: string
          description: When the advance was funded (ISO 8601).
        first_payment_date:
          type: string
          nullable: true
          description: First payment date (`YYYY-MM-DD`).
        expected_payoff_date:
          type: string
          nullable: true
          description: Expected payoff date (`YYYY-MM-DD`).
        actual_payoff_date:
          type: string
          nullable: true
          description: Actual payoff date (`YYYY-MM-DD`).
        created_at:
          type: string
          description: Creation time (ISO 8601).
        updated_at:
          type: string
          nullable: true
          description: Last update time (ISO 8601).
      required:
        - id
        - deal_id
        - business_id
        - business_name
        - lender_id
        - lender_name
        - offer_id
        - status
        - funded_amount
        - factor_rate
        - term
        - payment_frequency
        - payment_amount
        - payback_amount
        - paid_amount
        - remaining_balance
        - percent_paid
        - payments_made
        - payments_expected
        - position
        - renewal_ready
        - renewal_threshold
        - renewal_threshold_override
        - funded_at
        - first_payment_date
        - expected_payoff_date
        - actual_payoff_date
        - created_at
        - updated_at
    EmptyMetaDto:
      type: object
      properties: {}
    ErrorEnvelopeDto:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/PublicErrorDto'
      required:
        - error
    PublicErrorDto:
      type: object
      properties:
        type:
          type: string
          enum:
            - validation_error
            - authentication_error
            - permission_error
            - not_found
            - conflict
            - rate_limit_error
            - api_error
        message:
          type: string
          description: Human-readable explanation, safe to show to an operator or an agent.
        code:
          type: string
          description: >-
            Stable machine-readable code, e.g. `missing_scope`,
            `duplicate_business`.
        param:
          type: string
          description: Request field the error refers to, when applicable.
        request_id:
          type: string
          description: Echo of the `X-Request-Id` header. Quote it when contacting support.
      required:
        - type
        - message
        - request_id
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: API key or JWT
      type: http
      description: API key (`nlmca_live_…`) or OAuth access token

````

## Related topics

- [Get a business](/api-reference/businesses/get-a-business.md)
- [List advances](/api-reference/advances/list-advances.md)
- [Update an advance](/api-reference/advances/update-an-advance.md)
