Carrier Factors
Filter carrier factors
Query carrier factors (factoring companies) using flexible filter criteria with AND/OR logic.
By default, only non-deleted carrier factors are returned (deletedAt: { isNull: true }). Override this by explicitly setting deletedAt filter criteria.
Carrier factors represent factoring companies that provide payment services for carriers.
post/carrier-factors/filter
Request body
Example request
{
"filter": {
"and": [
{
"companyName": {
"includes": "Capital"
}
},
{
"currency": {
"equalTo": "USD"
}
}
]
},
"pageSize": 50
}Response
Filtered carrier factors with pagination
Example response
{
"data": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"companyName": "Capital Factoring Services Inc",
"key": "ERP-FACTOR-001",
"email": "accounting@capitalfactoring.com",
"phoneNumber": "+1-555-234-5678",
"phoneExtension": "123",
"fax": "+1-555-234-9999",
"addressLine1": "789 Finance Ave",
"addressLine2": "Suite 500",
"city": "Dallas",
"state": "TX",
"country": "USA",
"zipCode": "75201",
"bankName": "Chase Bank",
"bankAddress": "123 Bank Street, Dallas, TX 75201",
"accountName": "Capital Factoring 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"
}
],
"pageInfo": {
"pageSize": 50,
"hasNextPage": true,
"endCursor": "eyJpZCI6IjU1MGU4NDAwLWUyOWItNDFkNC1hNzE2LTQ0NjY1NTQ0MDAwMCJ9"
}
}