post https://yourorgsite.com/api/Invoice/_execute
Executes an operation of Invoice
With the Invoice service, you can perform the following operations on the execute endpoint:
- ProcessWriteOff
- ProcessRecordRefund
- ProcessOrderReversal
- ProcessAccrualReversal
- ProcessAccrualAdjustment
- ProcessCashReversal
- ProcessOrderAdjustment
- ProcessFundraisingReversal
- ProcessFundraisingAdjustment
- ProcessMultiplePledgeInvoiceReversal
- ProcessMultipleDuesInvoiceReversal
- ProcessMultipleAccrualDuesInvoiceReversal
- ProcessMultipleCashDuesInvoiceReversal
- CanInvoiceBeReversed
- CanCashInvoiceBeReversed
- CanInvoiceBeRefunded
- CanInvoiceBeReturned
- CanOrderInvoiceBeAdjusted
- CanAccrualInvoiceBeAdjusted
- HasPermissions
- GetTransactionsInvoiceReferenceNumber
- GetInvoiceByReferenceNumber
- GenerateEventInvoices
- GenerateEventInvoices
- GetPaymentMethodIdAndPaymentIdForInvoice
- GetInvoiceLinesIncludingAdjustmentsFromInvoice
- GetAllPledgeTransactionsByInvoiceReferenceNumber
ProcessWriteOff
BODY PARAMS:
{
"$type": "Asi.Soa.Core.DataContracts.GenericExecuteRequest, Asi.Contracts",
"OperationName": "ProcessWriteOff",
"EntityTypeName": "Invoice",
"Parameters": {
"$type": "System.Collections.ObjectModel.Collection`1[[System.Object, mscorlib]], mscorlib",
"$values": [
{
"$type": "Asi.Soa.Commerce.DataContracts.InvoiceActionWriteOffData",
"$value": "invoiceActionWriteOffData Value"
}
]
},
"ParameterTypeName": {
"$type": "System.Collections.ObjectModel.Collection`1[[System.String, mscorlib]], mscorlib",
"$values": [
"Asi.Soa.Commerce.DataContracts.InvoiceActionWriteOffData"
]
},
"UseJson": false
}
ProcessRecordRefund
BODY PARAMS:
{
"$type": "Asi.Soa.Core.DataContracts.GenericExecuteRequest, Asi.Contracts",
"OperationName": "ProcessRecordRefund",
"EntityTypeName": "Invoice",
"Parameters": {
"$type": "System.Collections.ObjectModel.Collection`1[[System.Object, mscorlib]], mscorlib",
"$values": [
{
"$type": "Asi.Soa.Commerce.DataContracts.InvoiceActionRecordRefundData",
"$value": "invoiceActionRecordRefundData Value"
}
]
},
"ParameterTypeName": {
"$type": "System.Collections.ObjectModel.Collection`1[[System.String, mscorlib]], mscorlib",
"$values": [
"Asi.Soa.Commerce.DataContracts.InvoiceActionRecordRefundData"
]
},
"UseJson": false
}
ProcessOrderReversal
BODY PARAMS:
{
"$type": "Asi.Soa.Core.DataContracts.GenericExecuteRequest, Asi.Contracts",
"OperationName": "ProcessOrderReversal",
"EntityTypeName": "Invoice",
"Parameters": {
"$type": "System.Collections.ObjectModel.Collection`1[[System.Object, mscorlib]], mscorlib",
"$values": [
{
"$type": "Asi.Soa.Commerce.DataContracts.InvoiceActionOrderReversalData",
"$value": "invoiceActionOrderReversalData Value"
}
]
},
"ParameterTypeName": {
"$type": "System.Collections.ObjectModel.Collection`1[[System.String, mscorlib]], mscorlib",
"$values": [
"Asi.Soa.Commerce.DataContracts.InvoiceActionOrderReversalData"
]
},
"UseJson": false
}
ProcessAccrualReversal
BODY PARAMS:
{
"$type": "Asi.Soa.Core.DataContracts.GenericExecuteRequest, Asi.Contracts",
"OperationName": "ProcessAccrualReversal",
"EntityTypeName": "Invoice",
"Parameters": {
"$type": "System.Collections.ObjectModel.Collection`1[[System.Object, mscorlib]], mscorlib",
"$values": [
{
"$type": "Asi.Soa.Commerce.DataContracts.InvoiceActionDuesReversalData",
"$value": "invoiceActionAccrualReversalData Value"
}
]
},
"ParameterTypeName": {
"$type": "System.Collections.ObjectModel.Collection`1[[System.String, mscorlib]], mscorlib",
"$values": [
"Asi.Soa.Commerce.DataContracts.InvoiceActionDuesReversalData"
]
},
"UseJson": false
}
ProcessAccrualAdjustment
BODY PARAMS:
{
"$type": "Asi.Soa.Core.DataContracts.GenericExecuteRequest, Asi.Contracts",
"OperationName": "ProcessAccrualAdjustment",
"EntityTypeName": "Invoice",
"Parameters": {
"$type": "System.Collections.ObjectModel.Collection`1[[System.Object, mscorlib]], mscorlib",
"$values": [
{
"$type": "Asi.Soa.Commerce.DataContracts.InvoiceActionAccrualAdjustmentData",
"$value": "invoiceActionAccrualAdjustmentData Value"
}
]
},
"ParameterTypeName": {
"$type": "System.Collections.ObjectModel.Collection`1[[System.String, mscorlib]], mscorlib",
"$values": [
"Asi.Soa.Commerce.DataContracts.InvoiceActionAccrualAdjustmentData"
]
},
"UseJson": false
}
ProcessCashReversal
BODY PARAMS:
{
"$type": "Asi.Soa.Core.DataContracts.GenericExecuteRequest, Asi.Contracts",
"OperationName": "ProcessCashReversal",
"EntityTypeName": "Invoice",
"Parameters": {
"$type": "System.Collections.ObjectModel.Collection`1[[System.Object, mscorlib]], mscorlib",
"$values": [
{
"$type": "Asi.Soa.Commerce.DataContracts.InvoiceActionCashReversalData",
"$value": "invoiceActionCashReversalData Value"
}
]
},
"ParameterTypeName": {
"$type": "System.Collections.ObjectModel.Collection`1[[System.String, mscorlib]], mscorlib",
"$values": [
"Asi.Soa.Commerce.DataContracts.InvoiceActionCashReversalData"
]
},
"UseJson": false
}
ProcessOrderAdjustment
BODY PARAMS:
{
"$type": "Asi.Soa.Core.DataContracts.GenericExecuteRequest, Asi.Contracts",
"OperationName": "ProcessOrderAdjustment",
"EntityTypeName": "Invoice",
"Parameters": {
"$type": "System.Collections.ObjectModel.Collection`1[[System.Object, mscorlib]], mscorlib",
"$values": [
{
"$type": "Asi.Soa.Commerce.DataContracts.InvoiceActionOrderAdjustmentData",
"$value": "invoiceActionOrderAdjustmentData Value"
}
]
},
"ParameterTypeName": {
"$type": "System.Collections.ObjectModel.Collection`1[[System.String, mscorlib]], mscorlib",
"$values": [
"Asi.Soa.Commerce.DataContracts.InvoiceActionOrderAdjustmentData"
]
},
"UseJson": false
}
ProcessFundraisingReversal
BODY PARAMS:
{
"$type": "Asi.Soa.Core.DataContracts.GenericExecuteRequest, Asi.Contracts",
"OperationName": "ProcessFundraisingReversal",
"EntityTypeName": "Invoice",
"Parameters": {
"$type": "System.Collections.ObjectModel.Collection`1[[System.Object, mscorlib]], mscorlib",
"$values": [
{
"$type": "Asi.Soa.Commerce.DataContracts.InvoiceActionFundraisingAdjustmentData",
"$value": "invoiceActionFundraisingData Value"
}
]
},
"ParameterTypeName": {
"$type": "System.Collections.ObjectModel.Collection`1[[System.String, mscorlib]], mscorlib",
"$values": [
"Asi.Soa.Commerce.DataContracts.InvoiceActionFundraisingAdjustmentData"
]
},
"UseJson": false
}
ProcessFundraisingAdjustment
BODY PARAMS:
{
"$type": "Asi.Soa.Core.DataContracts.GenericExecuteRequest, Asi.Contracts",
"OperationName": "ProcessFundraisingAdjustment",
"EntityTypeName": "Invoice",
"Parameters": {
"$type": "System.Collections.ObjectModel.Collection`1[[System.Object, mscorlib]], mscorlib",
"$values": [
{
"$type": "Asi.Soa.Commerce.DataContracts.InvoiceActionFundraisingAdjustmentData",
"$value": "invoiceActionFundraisingData Value"
}
]
},
"ParameterTypeName": {
"$type": "System.Collections.ObjectModel.Collection`1[[System.String, mscorlib]], mscorlib",
"$values": [
"Asi.Soa.Commerce.DataContracts.InvoiceActionFundraisingAdjustmentData"
]
},
"UseJson": false
}
ProcessMultiplePledgeInvoiceReversal
BODY PARAMS:
{
"$type": "Asi.Soa.Core.DataContracts.GenericExecuteRequest, Asi.Contracts",
"OperationName": "ProcessMultiplePledgeInvoiceReversal",
"EntityTypeName": "Invoice",
"Parameters": {
"$type": "System.Collections.ObjectModel.Collection`1[[System.Object, mscorlib]], mscorlib",
"$values": [
{
"$type": "System.Collections.Generic.ICollection`1[[Asi.Soa.Commerce.DataContracts.InvoiceActionFundraisingAdjustmentData, Asi.Contracts]]",
"$value": "listOfInvoiceActionFundraisingData Value"
}
]
},
"ParameterTypeName": {
"$type": "System.Collections.ObjectModel.Collection`1[[System.String, mscorlib]], mscorlib",
"$values": [
"System.Collections.Generic.ICollection`1[[Asi.Soa.Commerce.DataContracts.InvoiceActionFundraisingAdjustmentData, Asi.Contracts]]"
]
},
"UseJson": false
}
ProcessMultipleDuesInvoiceReversal
BODY PARAMS:
{
"$type": "Asi.Soa.Core.DataContracts.GenericExecuteRequest, Asi.Contracts",
"OperationName": "ProcessMultipleDuesInvoiceReversal",
"EntityTypeName": "Invoice",
"Parameters": {
"$type": "System.Collections.ObjectModel.Collection`1[[System.Object, mscorlib]], mscorlib",
"$values": [
{
"$type": "System.Collections.Generic.ICollection`1[[Asi.Soa.Commerce.DataContracts.InvoiceActionDuesReversalData, Asi.Contracts]]",
"$value": "listOfInvoiceActionAccrualReversalData Value"
}
]
},
"ParameterTypeName": {
"$type": "System.Collections.ObjectModel.Collection`1[[System.String, mscorlib]], mscorlib",
"$values": [
"System.Collections.Generic.ICollection`1[[Asi.Soa.Commerce.DataContracts.InvoiceActionDuesReversalData, Asi.Contracts]]"
]
},
"UseJson": false
}
ProcessMultipleAccrualDuesInvoiceReversal
BODY PARAMS:
{
"$type": "Asi.Soa.Core.DataContracts.GenericExecuteRequest, Asi.Contracts",
"OperationName": "ProcessMultipleAccrualDuesInvoiceReversal",
"EntityTypeName": "Invoice",
"Parameters": {
"$type": "System.Collections.ObjectModel.Collection`1[[System.Object, mscorlib]], mscorlib",
"$values": [
{
"$type": "System.Collections.Generic.ICollection`1[[Asi.Soa.Commerce.DataContracts.InvoiceActionDuesReversalData, Asi.Contracts]]",
"$value": "listOfInvoiceActionAccrualReversalData Value"
}
]
},
"ParameterTypeName": {
"$type": "System.Collections.ObjectModel.Collection`1[[System.String, mscorlib]], mscorlib",
"$values": [
"System.Collections.Generic.ICollection`1[[Asi.Soa.Commerce.DataContracts.InvoiceActionDuesReversalData, Asi.Contracts]]"
]
},
"UseJson": false
}
ProcessMultipleCashDuesInvoiceReversal
BODY PARAMS:
{
"$type": "Asi.Soa.Core.DataContracts.GenericExecuteRequest, Asi.Contracts",
"OperationName": "ProcessMultipleCashDuesInvoiceReversal",
"EntityTypeName": "Invoice",
"Parameters": {
"$type": "System.Collections.ObjectModel.Collection`1[[System.Object, mscorlib]], mscorlib",
"$values": [
{
"$type": "System.Collections.Generic.ICollection`1[[Asi.Soa.Commerce.DataContracts.InvoiceActionCashReversalData, Asi.Contracts]]",
"$value": "listOfInvoiceActionCashReversalData Value"
}
]
},
"ParameterTypeName": {
"$type": "System.Collections.ObjectModel.Collection`1[[System.String, mscorlib]], mscorlib",
"$values": [
"System.Collections.Generic.ICollection`1[[Asi.Soa.Commerce.DataContracts.InvoiceActionCashReversalData, Asi.Contracts]]"
]
},
"UseJson": false
}
CanInvoiceBeReversed
BODY PARAMS:
{
"$type": "Asi.Soa.Core.DataContracts.GenericExecuteRequest, Asi.Contracts",
"OperationName": "CanInvoiceBeReversed",
"EntityTypeName": "Invoice",
"Parameters": {
"$type": "System.Collections.ObjectModel.Collection`1[[System.Object, mscorlib]], mscorlib",
"$values": [
{
"$type": "System.Int32",
"$value": "invoiceReferenceNumber Value"
}
]
},
"ParameterTypeName": {
"$type": "System.Collections.ObjectModel.Collection`1[[System.String, mscorlib]], mscorlib",
"$values": [
"System.Int32"
]
},
"UseJson": false
}
CanCashInvoiceBeReversed
BODY PARAMS:
{
"$type": "Asi.Soa.Core.DataContracts.GenericExecuteRequest, Asi.Contracts",
"OperationName": "CanCashInvoiceBeReversed",
"EntityTypeName": "Invoice",
"Parameters": {
"$type": "System.Collections.ObjectModel.Collection`1[[System.Object, mscorlib]], mscorlib",
"$values": [
{
"$type": "System.String",
"$value": "invoiceId Value"
}
]
},
"ParameterTypeName": {
"$type": "System.Collections.ObjectModel.Collection`1[[System.String, mscorlib]], mscorlib",
"$values": [
"System.String"
]
},
"UseJson": false
}
CanInvoiceBeRefunded
BODY PARAMS:
{
"$type": "Asi.Soa.Core.DataContracts.GenericExecuteRequest, Asi.Contracts",
"OperationName": "CanInvoiceBeRefunded",
"EntityTypeName": "Invoice",
"Parameters": {
"$type": "System.Collections.ObjectModel.Collection`1[[System.Object, mscorlib]], mscorlib",
"$values": [
{
"$type": "System.Int32",
"$value": "invoiceReferenceNumber Value"
}
]
},
"ParameterTypeName": {
"$type": "System.Collections.ObjectModel.Collection`1[[System.String, mscorlib]], mscorlib",
"$values": [
"System.Int32"
]
},
"UseJson": false
}
CanInvoiceBeReturned
BODY PARAMS:
{
"$type": "Asi.Soa.Core.DataContracts.GenericExecuteRequest, Asi.Contracts",
"OperationName": "CanInvoiceBeReturned",
"EntityTypeName": "Invoice",
"Parameters": {
"$type": "System.Collections.ObjectModel.Collection`1[[System.Object, mscorlib]], mscorlib",
"$values": [
{
"$type": "System.Int32",
"$value": "invoiceReferenceNumber Value"
}
]
},
"ParameterTypeName": {
"$type": "System.Collections.ObjectModel.Collection`1[[System.String, mscorlib]], mscorlib",
"$values": [
"System.Int32"
]
},
"UseJson": false
}
CanOrderInvoiceBeAdjusted
BODY PARAMS:
{
"$type": "Asi.Soa.Core.DataContracts.GenericExecuteRequest, Asi.Contracts",
"OperationName": "CanOrderInvoiceBeAdjusted",
"EntityTypeName": "Invoice",
"Parameters": {
"$type": "System.Collections.ObjectModel.Collection`1[[System.Object, mscorlib]], mscorlib",
"$values": [
{
"$type": "System.Int32",
"$value": "invoiceReferenceNumber Value"
}
]
},
"ParameterTypeName": {
"$type": "System.Collections.ObjectModel.Collection`1[[System.String, mscorlib]], mscorlib",
"$values": [
"System.Int32"
]
},
"UseJson": false
}
CanAccrualInvoiceBeAdjusted
BODY PARAMS:
{
"$type": "Asi.Soa.Core.DataContracts.GenericExecuteRequest, Asi.Contracts",
"OperationName": "CanAccrualInvoiceBeAdjusted",
"EntityTypeName": "Invoice",
"Parameters": {
"$type": "System.Collections.ObjectModel.Collection`1[[System.Object, mscorlib]], mscorlib",
"$values": [
{
"$type": "System.Int32",
"$value": "invoiceReferenceNumber Value"
}
]
},
"ParameterTypeName": {
"$type": "System.Collections.ObjectModel.Collection`1[[System.String, mscorlib]], mscorlib",
"$values": [
"System.Int32"
]
},
"UseJson": false
}
HasPermissions
BODY PARAMS:
{
"$type": "Asi.Soa.Core.DataContracts.GenericExecuteRequest, Asi.Contracts",
"OperationName": "HasPermissions",
"EntityTypeName": "Invoice",
"Parameters": {
"$type": "System.Collections.ObjectModel.Collection`1[[System.Object, mscorlib]], mscorlib",
"$values": [
{
"$type": "System.String",
"$value": "requestingUserId Value"
},
{
"$type": "Asi.Soa.Commerce.DataContracts.InvoiceActionOperations",
"$value": "operationType Value"
}
]
},
"ParameterTypeName": {
"$type": "System.Collections.ObjectModel.Collection`1[[System.String, mscorlib]], mscorlib",
"$values": [
"System.String",
"Asi.Soa.Commerce.DataContracts.InvoiceActionOperations"
]
},
"UseJson": false
}
GetTransactionsInvoiceReferenceNumber
BODY PARAMS:
{
"$type": "Asi.Soa.Core.DataContracts.GenericExecuteRequest, Asi.Contracts",
"OperationName": "GetTransactionsInvoiceReferenceNumber",
"EntityTypeName": "Invoice",
"Parameters": {
"$type": "System.Collections.ObjectModel.Collection`1[[System.Object, mscorlib]], mscorlib",
"$values": [
{
"$type": "System.String",
"$value": "invoiceId Value"
}
]
},
"ParameterTypeName": {
"$type": "System.Collections.ObjectModel.Collection`1[[System.String, mscorlib]], mscorlib",
"$values": [
"System.String"
]
},
"UseJson": false
}
GetInvoiceByReferenceNumber
BODY PARAMS:
{
"$type": "Asi.Soa.Core.DataContracts.GenericExecuteRequest, Asi.Contracts",
"OperationName": "GetInvoiceByReferenceNumber",
"EntityTypeName": "Invoice",
"Parameters": {
"$type": "System.Collections.ObjectModel.Collection`1[[System.Object, mscorlib]], mscorlib",
"$values": [
{
"$type": "System.String",
"$value": "invoiceId Value"
}
]
},
"ParameterTypeName": {
"$type": "System.Collections.ObjectModel.Collection`1[[System.String, mscorlib]], mscorlib",
"$values": [
"System.String"
]
},
"UseJson": false
}
GenerateEventInvoices
BODY PARAMS:
{
"$type": "Asi.Soa.Core.DataContracts.GenericExecuteRequest, Asi.Contracts",
"OperationName": "GenerateEventInvoices",
"EntityTypeName": "Invoice",
"Parameters": {
"$type": "System.Collections.ObjectModel.Collection`1[[System.Object, mscorlib]], mscorlib",
"$values": [
{
"$type": "System.String",
"$value": "eventId Value"
},
{
"$type": "System.Boolean",
"$value": "outstandingBalanceOnly Value"
},
{
"$type": "System.Boolean",
"$value": "includeCancelledRegistrations Value"
}
]
},
"ParameterTypeName": {
"$type": "System.Collections.ObjectModel.Collection`1[[System.String, mscorlib]], mscorlib",
"$values": [
"System.String",
"System.Boolean",
"System.Boolean"
]
},
"UseJson": false
}
GenerateEventInvoices
BODY PARAMS:
{
"$type": "Asi.Soa.Core.DataContracts.GenericExecuteRequest, Asi.Contracts",
"OperationName": "GenerateEventInvoices",
"EntityTypeName": "Invoice",
"Parameters": {
"$type": "System.Collections.ObjectModel.Collection`1[[System.Object, mscorlib]], mscorlib",
"$values": [
{
"$type": "System.String",
"$value": "eventId Value"
},
{
"$type": "System.Boolean",
"$value": "outstandingBalanceOnly Value"
},
{
"$type": "System.Boolean",
"$value": "includeCancelledRegistrations Value"
},
{
"$type": "System.String",
"$value": "partyId Value"
}
]
},
"ParameterTypeName": {
"$type": "System.Collections.ObjectModel.Collection`1[[System.String, mscorlib]], mscorlib",
"$values": [
"System.String",
"System.Boolean",
"System.Boolean",
"System.String"
]
},
"UseJson": false
}
GetPaymentMethodIdAndPaymentIdForInvoice
BODY PARAMS:
{
"$type": "Asi.Soa.Core.DataContracts.GenericExecuteRequest, Asi.Contracts",
"OperationName": "GetPaymentMethodIdAndPaymentIdForInvoice",
"EntityTypeName": "Invoice",
"Parameters": {
"$type": "System.Collections.ObjectModel.Collection`1[[System.Object, mscorlib]], mscorlib",
"$values": [
{
"$type": "System.String",
"$value": "invoiceReferenceNumber Value"
}
]
},
"ParameterTypeName": {
"$type": "System.Collections.ObjectModel.Collection`1[[System.String, mscorlib]], mscorlib",
"$values": [
"System.String"
]
},
"UseJson": false
}
GetInvoiceLinesIncludingAdjustmentsFromInvoice
BODY PARAMS:
{
"$type": "Asi.Soa.Core.DataContracts.GenericExecuteRequest, Asi.Contracts",
"OperationName": "GetInvoiceLinesIncludingAdjustmentsFromInvoice",
"EntityTypeName": "Invoice",
"Parameters": {
"$type": "System.Collections.ObjectModel.Collection`1[[System.Object, mscorlib]], mscorlib",
"$values": [
{
"$type": "Asi.Soa.Commerce.DataContracts.InvoiceData",
"$value": "invoice Value"
},
{
"$type": "System.Boolean",
"$value": "includeAdjustmentParameters Value"
},
{
"$type": "System.Boolean",
"$value": "includeOrderLinesNotCompletedOrClosed Value"
}
]
},
"ParameterTypeName": {
"$type": "System.Collections.ObjectModel.Collection`1[[System.String, mscorlib]], mscorlib",
"$values": [
"Asi.Soa.Commerce.DataContracts.InvoiceData",
"System.Boolean",
"System.Boolean"
]
},
"UseJson": false
}
GetAllPledgeTransactionsByInvoiceReferenceNumber
BODY PARAMS:
{
"$type": "Asi.Soa.Core.DataContracts.GenericExecuteRequest, Asi.Contracts",
"OperationName": "GetAllPledgeTransactionsByInvoiceReferenceNumber",
"EntityTypeName": "Invoice",
"Parameters": {
"$type": "System.Collections.ObjectModel.Collection`1[[System.Object, mscorlib]], mscorlib",
"$values": [
{
"$type": "System.String",
"$value": "invoiceId Value"
}
]
},
"ParameterTypeName": {
"$type": "System.Collections.ObjectModel.Collection`1[[System.String, mscorlib]], mscorlib",
"$values": [
"System.String"
]
},
"UseJson": false
}