Create a payment

Record a customer payment applied to invoices.

What happens

Payment record is created
Specified amounts are applied to invoices
Invoice/order status updated to PAID when fully paid
Overpayment creates a credit memo automatically

Validations

Payment date must be >= invoice date for all applied invoices
Application amounts must not exceed invoice open balances
Customer must match invoice customer

Request body

customerIdstring uuid required

Customer making the payment

paymentDatestring date required

Date payment was received

Payment method type.

ACH_WIRE: ACH or wire transfer
ZELLE: Zelle payment
VENMO: Venmo payment
CHECK: Paper check
EFT_DIRECT_DEPOSIT: EFT direct deposit
E_TRANSFER: Electronic transfer
CREDIT_CARD: Credit card payment

referencestring

Check number, transaction ID, etc.

notesstring

Payment notes

Response

Payment created successfully

idstring uuid required

keystring nullable

Human-readable payment key

paymentDatestring date required

Date payment was received

Payment method type.

ACH_WIRE: ACH or wire transfer
ZELLE: Zelle payment
VENMO: Venmo payment
CHECK: Paper check
EFT_DIRECT_DEPOSIT: EFT direct deposit
E_TRANSFER: Electronic transfer
CREDIT_CARD: Credit card payment

referencestring nullable

Check number, transaction ID, etc.

notesstring nullable

Payment notes

currencystring nullable

Currency code

totalAmountnumber required

Total payment amount

overpaymentAmountnumber nullable

Amount in excess of invoice totals

overpaymentCreditMemoIdstring uuid nullable

Credit memo created from overpayment

shipmentIdsstring[]

Related shipment IDs

shipmentKeysstring[]

Related shipment friendly IDs

qboIdstring nullable

QuickBooks Online payment ID

createdAtstring date-time required

updatedAtstring date-time nullable

Example response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "key": "PMT-00001",
  "customer": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "key": "ERP-CUSTOMER-ACME",
    "name": "Acme Manufacturing Corp",
    "friendlyId": "A123456",
    "status": "ACTIVE",
    "phoneNumber": "+1-555-123-4567",
    "website": "https://acme-manufacturing.com",
    "createdAt": "2025-01-15T10:00:00Z",
    "updatedAt": "2025-01-15T14:30:00Z"
  },
  "currency": "USD"
}

v1