Vendor Payment Methods
Filter vendor payment methods
Query vendor payment methods using flexible filter criteria with AND/OR logic.
By default, only non-deleted payment methods are returned (deletedAt: { isNull: true }). Override this by explicitly setting deletedAt filter criteria.
Vendor payment methods define how and where payments are sent for a specific vendor.
post/vendor-payment-methods/filter
Request body
Example request
{
"filter": {
"and": [
{
"vendorId": {
"equalTo": "770e8400-e29b-41d4-a716-446655440000"
}
},
{
"isPreferred": {
"equalTo": true
}
}
]
},
"pageSize": 50
}Response
Filtered vendor payment methods with pagination
Example response
{
"data": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"vendorId": "770e8400-e29b-41d4-a716-446655440000",
"vendor": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"key": "ERP-VENDOR-ABC-001",
"friendlyId": "V123456",
"name": "ABC Warehouse Services",
"email": "billing@abcwarehouse.com",
"phone": "+1-555-123-4567",
"status": "ACTIVE",
"currency": "USD",
"createdAt": "2025-01-15T10:00:00Z",
"updatedAt": "2025-01-15T14:30:00Z"
},
"paymentMethodType": "ACH",
"status": "ACTIVE",
"isPreferred": true,
"email": "payments@vendor.com",
"phone": "+1-555-123-4567",
"companyName": "Vendor Payments LLC",
"username": "vendor_payments",
"bankName": "Chase Bank",
"bankAddress": "123 Bank Street, Dallas, TX 75201",
"accountName": "Vendor Services Inc",
"accountNumber": "****1234",
"abaAch": "021000021",
"wire": "026009593",
"swiftCode": "CHASUS33",
"eftInstitution": "001",
"eftTransit": "00010",
"clabe": "012180001234567897",
"currency": "USD",
"paymentTerm": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"key": "ERP-PAYTERM-NET30",
"name": "Net 30",
"description": "Payment due 30 days from invoice date",
"days": 30,
"quickPayFee": 0.05,
"createdAt": "2025-01-15T10:00:00Z",
"updatedAt": "2025-01-15T14:30:00Z"
},
"createdAt": "2025-01-15T10:00:00Z",
"updatedAt": "2025-01-15T14:30:00Z",
"deletedBy": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"key": "ERP-USER-12345",
"email": "john.doe@example.com",
"name": "John Doe",
"phone": "+1-555-123-4567",
"phoneExt": "123",
"status": "ACTIVE",
"avatarId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"createdAt": "2025-01-15T10:00:00Z",
"updatedAt": "2025-01-15T14:30:00Z"
}
}
],
"pageInfo": {
"pageSize": 50,
"hasNextPage": true,
"endCursor": "eyJpZCI6IjU1MGU4NDAwLWUyOWItNDFkNC1hNzE2LTQ0NjY1NTQ0MDAwMCJ9"
}
}