API Reference
  1. Benji Pays Merchant API
  2. Autoprocessing

List the auto-processing forecast for an Organization

get
https://api.benjipays.com/v2/autoprocessing-forecast

Returns a paginated auto-processing forecast: for each open invoice, whether it will be auto-charged on the supplied run date and the reasons behind that decision. Matches the merchant-app batch forecast report. Requires a connected accounting system.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
required
^\d{4}-\d{2}-\d{2}$

Run/report date the forecast is evaluated against (YYYY-MM-DD, interpreted as UTC).

string
length between 1 and 200

When provided, forecast only this single accounting-system invoice ID. Pagination parameters are ignored.

integer
1 to 100
Defaults to 20
integer
0 to 9007199254740991
Defaults to 0
Headers
uuid

Optional client-supplied unique ID for one request. The server generates a UUID v4 if omitted and always echoes the value in the response.

uuid

Optional ID that flows across service boundaries for distributed tracing. The server generates a UUID v4 if omitted and always echoes the value in the response.

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 10 days ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json

Updated 10 days ago

Did this page help you?