Get Next Action

Beta

GET

https://api.mercoa.com/invoice/:invoiceId/collection/next-action

Get the collection agent's next action on this invoice. This endpoint will return an empty object if there is no action to return.

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

invoiceIdstringRequired

Invoice ID or Invoice ForeignID

This endpoint returns an optional object.

emailobject

1	{
2	"type": "email",
3	"body": "Your invoice is now 3 days past due. Please make a payment at your earliest convenience.",
4	"id": "act_c3881909-c2f8-4a1e-878a-80a9b594483c",
5	"scheduledExecutionTime": "2024-01-04T13:00:00Z",
6	"status": "SUGGESTED",
7	"subject": "Invoice Past Due - Please Review"
8	}

1	import { MercoaClient } from "@mercoa/javascript";
2
3	const client = new MercoaClient({ token: "YOUR_TOKEN" });
4	await client.invoice.collection.getNextAction("in_3d61faa9-1754-4b7b-9fcb-88ff97f368ff");