ADadfin
Invoices

Activate (send) an invoice

Changed on
put/invoices/{id}:activate

Request

  • Base URL
    https://api.adfin.com/api
  • URL
    https://api.adfin.com/api/invoices/{id}:activate
  • 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

idstring required

The id of the invoice

Request body

collectionMethod'ONE_TIME_PAYMENT' | 'DIRECT_DEBIT_PAYMENT' | 'NONE'

How the payment is expected to be collected for this invoice.

customMessagestring

An optional message that will be sent to the customer when the invoice is activated.

templateIdstring

The schedule template id used for sending the invoice to customer.

Response

The invoice was activated

Changes

  • f651a1d29eedRevision changes
    • info

      the endpoint scheme security Biller Access Token (Production) was added to the API

    • info

      the endpoint scheme security Biller Access Token (Staging) was added to the API

  • cbec1c02c8cfRevision changes
    • breaking

      for the path request parameter id, the minLength was increased from 0 to 1