Skip to main content

Export Claims with Strategy and Days in Execution Use Case

Use get_claims when you need your whole portfolio in one pass: every claim, the dunning strategy it is on, and how many days it has been in execution. A typical case is a recurring export for reporting, reconciliation or an audit, which you can run yourself whenever you need it.

get_claims reads across all your accounts. To read the claims of one account, use get_account_claims instead. See the Get Account Claims Use Case.

Be sure to include the Authorization header with the access_token as its value, without a Bearer prefix. The access_token is provided by the authentication request.

Example​

You want the days in execution of every active claim, with the account each claim belongs to and the strategy it is on.

GET /account/v1/3d132b18-6b6f-4f7c-b464-6a8ee7ca5235/get_claims?status=ACTIVE&fields=claimReference&fields=accountReference&fields=daysInExecution&fields=originalDaysInExecution&fields=strategy HTTP/1.1
Host: api.receive-demo.com
Authorization: {{access_token}}
{
"results": [
{
"claimReference": "INV-2026-0042",
"accountReference": "ACC-DE-5567",
"daysInExecution": 12,
"originalDaysInExecution": 184,
"strategy": {
"blueprintId": "3f8a1c9e-6f2b-4f0e-9a4d-2f6c1f9b8e21",
"blueprintDisplayName": "Standard Dunning DE",
"status": "active",
"updatedAt": 1785542400000,
"daysInExecution": 12,
"originalDaysInExecution": 184
}
},
{
"claimReference": "INV-2026-0043",
"accountReference": "ACC-DE-5568",
"daysInExecution": 37,
"originalDaysInExecution": 37,
"strategy": null
}
],
"paginationId": "eyJjbGllbnRJZCI6IjNkMTMyYjE4LTZiNmYtNGY3Yy1iNDY0LTZhOGVlN2NhNTIzNSIsImV4dGVybmFsQ2xhaW1SZWYiOiJJTlYtMjAyNi0wMDQzIn0"
}

Choosing what comes back​

ParameterWhat it does
fieldsThe claim fields to return. Repeat the parameter for each field (fields=claimReference&fields=strategy). A comma-separated list is rejected. Leave it out to get the full claim, without strategy.
statusACTIVE or RESOLVED. Leave it out to get both.
limitClaims per page, from 1 to 10000. The default is 1000.
paginationIdThe cursor returned by the previous page.

strategy, daysInExecution and originalDaysInExecution are only returned when you name them in fields. If you only need the days in execution, leave strategy out: the response is smaller and faster to produce.

Reading the days in execution​

Every claim has two counters. Both are whole days, counted in the timezone set in your general configuration.

FieldMeaning
originalDaysInExecutionDays since the claim was created. It only ever grows.
daysInExecutionDays in execution as the dunning strategy counts them today. A strategy can set this counter, typically back to 0 when the claim enters a new cycle.

Three things to keep in mind when you read them:

  • 0 does not mean a new claim. It means the strategy restarted the counter today. If your strategy restarts it on every cycle, a large share of your portfolio can show 0 or 1 on any given day. Use originalDaysInExecution when you want the age of the claim.
  • The two are equal until the strategy sets the counter. For a claim whose strategy never set it, daysInExecution is the same number as originalDaysInExecution.
  • Every claim has them, with or without a strategy. The second claim in the example has strategy: null and still returns both counters. A counter is null only when it cannot be determined.

In the example above, the first claim was created 184 days ago and its strategy last restarted the counter 12 days ago. The second has no strategy, so both counters show its age.

Reading the strategy​

Add fields=strategy to also get the dunning strategy of each claim. It is null when no strategy assignment is recorded for the claim.

FieldMeaning
blueprintIdIdentifier of the strategy the claim is on.
blueprintDisplayNameName of that strategy as shown in the Backoffice. null when it has none.
statusactive, paused, stopped or deleted: the state of the strategy on this claim.
updatedAtWhen the strategy assignment was last recorded, in epoch milliseconds. It is not the time a counter was set.
daysInExecution, originalDaysInExecutionThe same two counters as on the claim, repeated here.

Reading every page​

The response is always paginated. Send the paginationId you received as a query parameter to get the next page, and repeat until it comes back as null.

GET /account/v1/3d132b18-6b6f-4f7c-b464-6a8ee7ca5235/get_claims?status=ACTIVE&fields=claimReference&fields=accountReference&fields=daysInExecution&fields=originalDaysInExecution&fields=strategy&paginationId=eyJjbGllbnRJZCI6IjNkMTMyYjE4LTZiNmYtNGY3Yy1iNDY0LTZhOGVlN2NhNTIzNSIsImV4dGVybmFsQ2xhaW1SZWYiOiJJTlYtMjAyNi0wMDQzIn0 HTTP/1.1
Host: api.receive-demo.com
Authorization: {{access_token}}

A page can hold fewer claims than limit, or none at all, while more pages remain. Do not stop because a page looks short. Stop when paginationId is null.

Expect more requests than limit suggests. A page covers a fixed amount of stored claim data, whatever limit and fields you send, and claims left out by status still count towards it. The number of requests therefore follows the size of your whole portfolio, resolved claims included, not the number of claims you get back.

Keep the same status and fields on every page of one export, and treat paginationId as opaque: do not build or edit it.

Where else the counters appear​

get_account_claims and get_debtor_accounts_and_claims accept the same fields, so daysInExecution, originalDaysInExecution and strategy can be read there too.

FAQ​

  • Can I get the days in execution without the strategy? Yes. Ask for fields=daysInExecution and fields=originalDaysInExecution and leave strategy out.
  • Do the counters change during the day? They change when the day changes in the timezone set in your general configuration, and daysInExecution also changes when the strategy sets it. Run a daily export at the same time each day to compare like with like.
  • Why does a claim I know is active return strategy: null? No strategy assignment is recorded for it. That happens when no strategy was ever assigned to the claim, or when its strategy ended before an assignment was recorded. Its days in execution are still returned as claim fields.