Preview cash application
curl --request POST \
--url https://api.entendre.finance/v1/cash-applications/preview \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"deposit_transaction_id": "txn_507f1f77bcf86cd799439011"
}
'const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({deposit_transaction_id: 'txn_507f1f77bcf86cd799439011'})
};
fetch('https://api.entendre.finance/v1/cash-applications/preview', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.entendre.finance/v1/cash-applications/preview"
payload = { "deposit_transaction_id": "txn_507f1f77bcf86cd799439011" }
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"data": {
"deposit": {
"id": "txn_507f1f77bcf86cd799439011",
"amount": "100.00",
"memo": "Invoice payment",
"txn_date": "2026-08-31T12:00:00Z"
},
"derived_customer": null,
"suggestions": [
{
"match_type": "exact",
"confidence": 1,
"total_amount": "100.00",
"delta": "0.00",
"allocations": [
{
"target_type": "invoice",
"target_id": "inv_507f1f77bcf86cd799439011",
"invoice_number": "INV-1001",
"amount": "100.00",
"customer_name": "Example customer"
}
]
}
],
"candidate_pool_size": 1,
"truncated": false
}
}{
"error": {
"code": "VALIDATION_ERROR",
"message": "Invalid path, query or request body.",
"request_id": "req_example"
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "Authentication is required.",
"request_id": "req_example"
}
}{
"error": {
"code": "FORBIDDEN",
"message": "Insufficient access to organization",
"request_id": "req_example"
}
}{
"error": {
"code": "RESOURCE_NOT_FOUND",
"message": "Resource not found",
"request_id": "req_example"
}
}{
"error": {
"code": "CONFLICT",
"message": "The resource state does not allow this operation.",
"request_id": "req_example"
}
}{
"error": {
"code": "RATE_LIMITED",
"message": "Rate limit exceeded. Retry after 30s.",
"request_id": "req_example"
}
}{
"error": {
"code": "INTERNAL_ERROR",
"message": "Internal server error",
"request_id": "req_example"
}
}{
"error": {
"code": "SERVICE_UNAVAILABLE",
"message": "Service unavailable.",
"request_id": "req_example"
}
}Cash Application
Preview cash application
Suggests ranked invoice allocations for a deposit. The preview writes no data, reserves nothing and posts no journals.
POST
/
v1
/
cash-applications
/
preview
Preview cash application
curl --request POST \
--url https://api.entendre.finance/v1/cash-applications/preview \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"deposit_transaction_id": "txn_507f1f77bcf86cd799439011"
}
'const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({deposit_transaction_id: 'txn_507f1f77bcf86cd799439011'})
};
fetch('https://api.entendre.finance/v1/cash-applications/preview', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.entendre.finance/v1/cash-applications/preview"
payload = { "deposit_transaction_id": "txn_507f1f77bcf86cd799439011" }
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"data": {
"deposit": {
"id": "txn_507f1f77bcf86cd799439011",
"amount": "100.00",
"memo": "Invoice payment",
"txn_date": "2026-08-31T12:00:00Z"
},
"derived_customer": null,
"suggestions": [
{
"match_type": "exact",
"confidence": 1,
"total_amount": "100.00",
"delta": "0.00",
"allocations": [
{
"target_type": "invoice",
"target_id": "inv_507f1f77bcf86cd799439011",
"invoice_number": "INV-1001",
"amount": "100.00",
"customer_name": "Example customer"
}
]
}
],
"candidate_pool_size": 1,
"truncated": false
}
}{
"error": {
"code": "VALIDATION_ERROR",
"message": "Invalid path, query or request body.",
"request_id": "req_example"
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "Authentication is required.",
"request_id": "req_example"
}
}{
"error": {
"code": "FORBIDDEN",
"message": "Insufficient access to organization",
"request_id": "req_example"
}
}{
"error": {
"code": "RESOURCE_NOT_FOUND",
"message": "Resource not found",
"request_id": "req_example"
}
}{
"error": {
"code": "CONFLICT",
"message": "The resource state does not allow this operation.",
"request_id": "req_example"
}
}{
"error": {
"code": "RATE_LIMITED",
"message": "Rate limit exceeded. Retry after 30s.",
"request_id": "req_example"
}
}{
"error": {
"code": "INTERNAL_ERROR",
"message": "Internal server error",
"request_id": "req_example"
}
}{
"error": {
"code": "SERVICE_UNAVAILABLE",
"message": "Service unavailable.",
"request_id": "req_example"
}
}To apply a suggestion, send its allocations to Create and apply cash application.
Authorizations
Your organization API key. Some operations also need a key that is associated with a user; their pages say so.
Body
application/json
Response
The request succeeded.
Show child attributes
Show child attributes