---
title: "BalanceRequest"
url: "https://stage-api-docs.centraldispatch.com/apis/stage-fulfillment-api-1-0-0/versions/8637c155-7ff6-49fa-ac0a-3b4df78c9665/schemas/BalanceRequest"
---

> Full API specification: https://stage-api-docs.centraldispatch.com/apis/stage-fulfillment-api-1-0-0/versions/8637c155-7ff6-49fa-ac0a-3b4df78c9665.md

# BalanceRequest

Details of a dispatch balance.

## OpenAPI definition

```yaml
openapi: 3.0.1
info:
  title: Fulfillment API
  version: 1.0.0
servers:
  - url: https://fulfillment-api.centraldispatch.com
    description: Production server
components:
  schemas:
    BalanceRequest:
      type: object
      properties:
        amount:
          minimum: 0.01
          type: number
          description: The balance amount that will be due after the COD/COP payment is
            applied.
          format: double
          example: 300
        paymentTime:
          enum:
            - IMMEDIATELY
            - TWO_BUSINESS_DAYS_QUICK_PAY
            - FIVE_BUSINESS_DAYS
            - TEN_BUSINESS_DAYS
            - FIFTEEN_BUSINESS_DAYS
            - THIRTY_BUSINESS_DAYS
          type: string
          description: The time frame when the balance payment is due. Required if
            `amount` is greater than 0. This list is not exhaustive and
            additional values may be added at any time.
          nullable: true
        balancePaymentTermsBeginOn:
          enum:
            - PICKUP
            - DELIVERY
            - RECEIVING_SIGNED_BOL
          type: string
          description: The terms for beginning balance payment. Required if `amount` is
            greater than 0. This list is not exhaustive and additional values
            may be added at any time.
          nullable: true
          example: PICKUP
        balancePaymentMethod:
          enum:
            - CASH
            - CERTIFIED_FUNDS
            - COMPANY_CHECK
            - COMCHEK
            - TCH
          type: string
          description: The payment method with which the balance due payment will be paid.
            Required if `amount` is greater than 0. This list is not exhaustive
            and additional values may be added at any time.
          nullable: true
          example: CASH
      description: Details of a dispatch balance.
      nullable: true
```