Sign in

v1

latestOpenAPI 3.1.0Proprietary2026-08-06177398877.4 KB
Payments

Update a payment

Update payment details or reassign invoice applications.

What happens

  • Payment fields are updated
  • Invoice applications are replaced if provided
  • Order statuses are recalculated

Note

Updating applications replaces all existing applications. Include all desired applications in the request.

patch/payments/{id}

Path parameters

idstring required

Resource ID (UUID) or client key

Query parameters

by'id' | 'key'

Specify lookup type for faster retrieval. If omitted, defaults to looking up by ID first, then falls back to client key if not found. Use by=key when you know you're providing a client key for best performance.

Request body

paymentDatestring date
paymentMethodType'ACH_WIRE' | 'ZELLE' | 'VENMO' | 'CHECK' | 'EFT_DIRECT_DEPOSIT' | 'E_TRANSFER' | 'CREDIT_CARD'

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
notesstring nullable

Response

Payment updated successfully

idstring uuid required
keystring nullable

Human-readable payment key

paymentDatestring date required

Date payment was received

paymentMethodType'ACH_WIRE' | 'ZELLE' | 'VENMO' | 'CHECK' | 'EFT_DIRECT_DEPOSIT' | 'E_TRANSFER' | 'CREDIT_CARD'

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"
}