HomeGuidesAPI ReferenceChangelogDiscussions
GuidesiMIS ProfessionaliMIS EnterpriseClient SupportLog In
API Reference

Executes an AutoPayInstruction operation

Executes an operation of AutoPayInstruction

With the AutoPayInstruction service, you can perform the following operations on the execute endpoint:

  • Cancel
  • GetInstructionsForContact
  • GetInstructionsForAutoPayAccount
  • GetInvoicesForInstruction

Cancel

BODY PARAMS:
{
  "$type": "Asi.Soa.Core.DataContracts.GenericExecuteRequest, Asi.Contracts",
  "OperationName": "Cancel",
  "EntityTypeName": "AutoPayInstruction",
  "Parameters": {
    "$type": "System.Collections.ObjectModel.Collection`1[[System.Object, mscorlib]], mscorlib",
    "$values": [
      {
        "$type": "System.String",
        "$value": "autoPayInstructionId Value"
      },
      {
        "$type": "System.Nullable`1[[System.DateTime, mscorlib, ]]",
        "$value": "cancellationDate Value"
      },
      {
        "$type": "System.String",
        "$value": "cancelledReason Value"
      }
    ]
  },
  "ParameterTypeName": {
    "$type": "System.Collections.ObjectModel.Collection`1[[System.String, mscorlib]], mscorlib",
    "$values": [
      "System.String",
      "System.Nullable`1[[System.DateTime, mscorlib, ]]",
      "System.String"
    ]
  },
  "UseJson": false
}

GetInstructionsForContact

BODY PARAMS:
{
  "$type": "Asi.Soa.Core.DataContracts.GenericExecuteRequest, Asi.Contracts",
  "OperationName": "GetInstructionsForContact",
  "EntityTypeName": "AutoPayInstruction",
  "Parameters": {
    "$type": "System.Collections.ObjectModel.Collection`1[[System.Object, mscorlib]], mscorlib",
    "$values": [
      {
        "$type": "System.String",
        "$value": "contactId Value"
      }
    ]
  },
  "ParameterTypeName": {
    "$type": "System.Collections.ObjectModel.Collection`1[[System.String, mscorlib]], mscorlib",
    "$values": [
      "System.String"
    ]
  },
  "UseJson": false
}

GetInstructionsForAutoPayAccount

BODY PARAMS:
{
  "$type": "Asi.Soa.Core.DataContracts.GenericExecuteRequest, Asi.Contracts",
  "OperationName": "GetInstructionsForAutoPayAccount",
  "EntityTypeName": "AutoPayInstruction",
  "Parameters": {
    "$type": "System.Collections.ObjectModel.Collection`1[[System.Object, mscorlib]], mscorlib",
    "$values": [
      {
        "$type": "System.String",
        "$value": "autoPayAccountId Value"
      }
    ]
  },
  "ParameterTypeName": {
    "$type": "System.Collections.ObjectModel.Collection`1[[System.String, mscorlib]], mscorlib",
    "$values": [
      "System.String"
    ]
  },
  "UseJson": false
}

GetInvoicesForInstruction

BODY PARAMS:
{
  "$type": "Asi.Soa.Core.DataContracts.GenericExecuteRequest, Asi.Contracts",
  "OperationName": "GetInvoicesForInstruction",
  "EntityTypeName": "AutoPayInstruction",
  "Parameters": {
    "$type": "System.Collections.ObjectModel.Collection`1[[System.Object, mscorlib]], mscorlib",
    "$values": [
      {
        "$type": "System.String",
        "$value": "instructionId Value"
      }
    ]
  },
  "ParameterTypeName": {
    "$type": "System.Collections.ObjectModel.Collection`1[[System.String, mscorlib]], mscorlib",
    "$values": [
      "System.String"
    ]
  },
  "UseJson": false
}
Language
Credentials
OAuth2
Click Try It! to start a request and see the response here!