Skip to main content

Payment Item API

Create and manage payment items for recording payment methods on cash sales and customer payments.

Endpoints​

MethodEndpointDescription
GET/record/v1/paymentItemList payment items
GET/record/v1/paymentItem/{id}Get specific item
POST/record/v1/paymentItemCreate item
PATCH/record/v1/paymentItem/{id}Update item
DELETE/record/v1/paymentItem/{id}Delete item

Key Fields​

FieldTypeDescriptionRequired
itemIdstringItem name/numberYes (if not auto)
displayNamestringDisplay nameNo
descriptionstringItem descriptionNo
paymentMethodobjectAssociated payment methodYes
accountobjectDeposit accountNo
creditCardobjectCredit card type (if applicable)No
undepFundsobjectUndeposited funds accountNo
includeChildrenbooleanInclude child subsidiariesNo
isInactivebooleanInactive flagNo

Example: Create Payment Item​

POST /record/v1/paymentItem
Content-Type: application/json
{
  "itemId": "PAYMENT-VISA",
  "displayName": "Visa Credit Card Payment",
  "description": "Visa credit card payment method",
  "paymentMethod": {
    "id": "1"
  },
  "creditCard": {
    "id": "1"
  },
  "undepFunds": {
    "id": "1100"
  }
}

Response:

{
  "id": "978",
  "itemId": "PAYMENT-VISA",
  "displayName": "Visa Credit Card Payment",
  "description": "Visa credit card payment method",
  "paymentMethod": {
    "id": "1",
    "refName": "Credit Card"
  },
  "creditCard": {
    "id": "1",
    "refName": "Visa"
  },
  "undepFunds": {
    "id": "1100",
    "refName": "Undeposited Funds"
  },
  "isInactive": false,
  "lastModifiedDate": "2025-12-25T10:30:00Z"
}

Example: Update Payment Item​

PATCH /record/v1/paymentItem/978
Content-Type: application/json
{
  "displayName": "Visa Card Payment",
  "description": "Visa credit card payment - updated"
}

Response:

{
  "id": "978",
  "itemId": "PAYMENT-VISA",
  "displayName": "Visa Card Payment",
  "description": "Visa credit card payment - updated",
  "lastModifiedDate": "2025-12-25T11:00:00Z"
}

Query Filters​

Find Active Payment Items​

GET /record/v1/paymentItem?q=isInactive=false

Find by Item ID Pattern​

GET /record/v1/paymentItem?q=itemId LIKE 'PAYMENT%'

Find by Payment Method​

GET /record/v1/paymentItem?q=paymentMethod.id=1

Find Credit Card Payment Items​

GET /record/v1/paymentItem?q=creditCard.id IS NOT NULL

Important Notes​

  • Payment items are used to record payment methods on cash sales and customer payments
  • Payment items link to payment methods which define how customers pay (cash, check, credit card, etc.)
  • Payment items are primarily used on:
    • Cash sales
    • Customer payments
    • Point of sale transactions
  • The paymentMethod field is required and must reference a valid payment method in NetSuite
  • The creditCard field should be populated when the payment method is a credit card type
  • Payment items can specify:
    • account: The bank or cash account where funds are deposited
    • undepFunds: The undeposited funds account for payments pending deposit
  • Common payment item types:
    • Cash payments
    • Check payments
    • Credit card payments (Visa, Mastercard, Amex, Discover)
    • Debit card payments
    • Electronic payments (ACH, wire transfer)
    • Digital wallet payments (PayPal, Apple Pay, etc.)
  • Payment items do not post to the general ledger themselves; they specify where the payment posts
  • Payment items are particularly useful in retail and point-of-sale scenarios
  • Multiple payment items can be created for the same payment method to track different card types or accounts
  • Unlike other item types, payment items:
    • Do not have prices or costs
    • Do not require subsidiary assignment (even in OneWorld)
    • Do not affect inventory
    • Are only used for payment tracking

Common Payment Item Configurations​

Cash Payment​

{
  "itemId": "PAYMENT-CASH",
  "displayName": "Cash Payment",
  "paymentMethod": {"id": "1"},
  "undepFunds": {"id": "1100"}
}

Check Payment​

{
  "itemId": "PAYMENT-CHECK",
  "displayName": "Check Payment",
  "paymentMethod": {"id": "2"},
  "undepFunds": {"id": "1100"}
}

Credit Card Payment​

{
  "itemId": "PAYMENT-MASTERCARD",
  "displayName": "Mastercard Payment",
  "paymentMethod": {"id": "5"},
  "creditCard": {"id": "2"},
  "undepFunds": {"id": "1100"}
}

Electronic Payment​

{
  "itemId": "PAYMENT-ACH",
  "displayName": "ACH Electronic Payment",
  "paymentMethod": {"id": "6"},
  "account": {"id": "1000"}
}

See Also​