ADadfin
Recurring invoices

Get the collection preferences for a recurring invoice

Changed on

Returns how collection is set up for the invoices this recurring invoice raises. The values in force, after the agent's settings and every override are resolved.

get/schedules/invoices/{recurringInvoiceId}/collection_preferences

Request

  • Base URL
    https://api.adfin.com/api
  • URL
    https://api.adfin.com/api/schedules/invoices/{recurringInvoiceId}/collection_preferences
  • Auth
    • OAuth 2
      Client credentials
      Token URL: https://api.staging.adfin.com/api/oauth2/token
    • or OAuth 2
      Client credentials
      Token URL: https://api.adfin.com/api/oauth2/token

Path parameters

recurringInvoiceIdstring uuid required

The identifier of the recurring invoice.

Response

The collection method and preferences in force.

collectionMethod'AUTO_COLLECT' | 'ON_DEMAND' required

The collection method in force.

Changes