invoice > collection

Get 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.

get/invoice/{invoiceId}/collection/next-action

Request

  • Base URL: https://api.mercoa.com
  • URL: https://api.mercoa.com/invoice/{invoiceId}/collection/next-action
  • Auth: HTTP bearer

Path parameters

invoiceIdstring required

Invoice ID or Invoice ForeignID

Response

Response with status 200

type'email' required

Discriminator value: email

idstring required
scheduledExecutionTimestring date-time required

The UTC timestamp for when this action is scheduled for execution. Actual execution may be delayed by a few minutes due to processing time.

status'SUGGESTED' | 'APPROVED' | 'COMPLETED' required
subjectstring required

The subject of the email

bodystring required

The body of the email in plaintext

Changes

No recorded changes to this operation across all 1 revision of this API.