Atomia Billing API documentation
Atomia.Billing.Core.Sdk
IAtomiaBillingApi Interface
IAtomiaBillingApi Methods
ActivateItem Method
AddAccountDetails Method
AddBillingReport Method
AddCampaign Method
AddMailingList Method
AddPackageConfiguration Method
AddPaymentProfile Method
AddProvisioningPackage Method
AddProvisioningService Method
AddReportDataSource Method
AddShopItem Method
AddShopItemCategory Method
AddTaxProfile Method
AddTemplate Method
AllowRole Method
AllowUser Method
BindPayFileRecordToInvoice Method
BindSubscriptionsToInvoice Method
BulkPrintAndSendInvoices Method
BulkPrintInvoices Method
BulkPrintInvoicesSynchronous Method
BulkSendInvoices Method
BulkSendInvoicesSynchronous Method
CalculateCreditedInvoiceTotals Method
CalculateTotals Method
CampaignPromoCodesBulkDelete Method
CanCreateAccount Method
ChangeAccountStatus Method
ChangeOrderStatus Method
ChangeRefundStatus Method
ChangeSubscriptionProduct Method
ChangeSubscriptionStatus Method
ChangeTasksToRunStatus Method
CheckDomains Method
CheckDomainsForTransfer Method
CheckEmail Method
CheckInvoiceOrder Method
CheckInvoiceSendingOrder Method
CountSubscriptionsByType Method
CountSubscriptionsByTypesAndStatuses Method
CreateClonedShop Method
CreateCreditedInvoice Method
CreateCreditedInvoiceFromInvoice Method
CreateCurrency Method
CreateCustomer Method
CreateInvoice Method
CreateInvoiceFromOrder Method
CreateItem Method
CreateJob Method
CreateMessage Method
CreateOrder Method
CreatePartiallyCreditedInvoice Method
CreatePartialRefundFromPaymentId Method
CreatePartialRefundFromPaymentIdChangeStatus Method
CreatePayment Method
CreatePluginConfiguration Method
CreatePrepaidCreditRecords Method
CreateRefund Method
CreateRefundFromCreditedInvoice Method
CreateRefundFromPaymentId Method
CreateRefundFromPaymentIdChangeStatus Method
CreateSchedule Method
CreateShop Method
CreateSubscription Method
CreateSubscriptions Method
CreateTerminateAccountRequests Method
CreateUpgradeGroup Method
CreateUpgradeInvoice Method
CreateUpgradeOrder Method
DeactivateItem Method
DeleteAzureMarkups Method
DeleteBillingReport Method
DeleteCampaign Method
DeleteCampaignsBulk Method
DeleteInvoice Method
DeletePackageConfiguration Method
DeletePayment Method
DeletePaymentProfile Method
DeletePluginConfiguration Method
DeleteProvisioningPackage Method
DeleteProvisioningService Method
DeleteReportArchiveBulk Method
DeleteReportDataSource Method
DeleteScheduledTask Method
DeleteShop Method
DeleteShopItem Method
DeleteShopItemCategory Method
DeleteTaxProfile Method
DeleteTemplate Method
DeleteUpgradeGroup Method
DenyRole Method
DenyUser Method
DisablePlugin Method
DowngradeSubscription Method
DowngradeSubscriptionToCheapestPackage Method
Echo Method
EnablePlugin Method
ExportReportData Method
ExtendSubscription Method
FindShopItem Method
FinishPayment Method
FlushItemsCache Method
GetAccount Method
GetAccountById Method
GetAccountByName Method
GetAccountDefaultCurrency Method
GetAccountDetails Method
GetAccountDetailsByHash Method
GetAccountDetailsForAccounts Method
GetAccountForUser Method
GetAccountForUserWithDetails Method
GetAccountsAllowedStatuses Method
GetActiveCurrencies Method
GetActiveShopByNameForReseller Method
GetAddressInfo Method
GetAllowedObjects Method
GetAllowedOperationsRole Method
GetAllowedOperationsUser Method
GetAllPaymentMethods Method
GetAllUpgradeGroups Method
GetAttachment Method
GetAvailableInvoiceVias Method
GetAvailableItems Method
GetAvailablePaymentMethods Method
GetAvailableTaxRules Method
GetAzurePriceList Method
GetAzurePriceListFilters Method
GetAzureUsageForInvoicing Method
GetBillingReportById Method
GetBulkSendJobById Method
GetBulkSendStatusByExternalId Method
GetBulkSendStatusById Method
GetBulkSendStatusesByExternalId Method
GetCampaignById Method
GetCampaigns Method
GetContacts Method
GetCounterTypesWithPrices Method
GetCountries Method
GetCreditedElectronicInvoice Method
GetCreditedInvoiceById Method
GetCreditedInvoiceByNo Method
GetCreditedInvoices Method
GetCreditedInvoicesOfInvoice Method
GetCurrencies Method
GetCurrency Method
GetCurrencyByCode Method
GetCustomerPackagesByEmail Method
GetCustomerReminder Method
GetDefaultPaymentMethod Method
GetDefaultShopForReseller Method
GetDefaultShopProducts Method
GetDomainsRegStatusLocal Method
GetDomainTransferStatus Method
GetElectronicInvoice Method
GetExecutingMethods Method
GetFinancialObligation Method
GetFinancialRecords Method
GetInvoiceById Method
GetInvoiceByNo Method
GetInvoiceOverview Method
GetInvoices Method
GetItem Method
GetItemByArticleNumber Method
GetItemCategories Method
GetItemDetails Method
GetItems Method
GetItemsByArticleNumber Method
GetItemsByIdsAndLanguage Method
GetItemsByProvisioningService Method
GetItemsCacheFlushTime Method
GetItemsForCurrency Method
GetItemsForPublicOrder Method
GetLanguageByCode Method
GetMailingListById Method
GetMailingListByName Method
GetMailingListSubscription Method
GetMainSubscription Method
GetMaximumRenewalPeriod Method
GetMessageById Method
GetMultiInstancePerformanceCounterAverage Method
GetNextInvoiceReminder Method
GetNextPostpaidInvoiceDate Method
GetNextWorkingDay Method
GetNumTasksPossibleToUpdate Method
GetOrderById Method
GetOrderByInvoiceNumber Method
GetOrderByNumber Method
GetOrders Method
GetOrdersByInvoiceNumber Method
GetOrderStatus Method
GetOrderStatusPriorities Method
GetPackageConfiguration Method
GetPackageSubscriptions Method
GetPaidAmount Method
GetPayFileRecordById Method
GetPaymentById Method
GetPaymentDiagnostics Method
GetPaymentMatchResult Method
GetPaymentMethodById Method
GetPaymentMethods Method
GetPaymentOverview Method
GetPaymentProfiles Method
GetPaymentRuleResult Method
GetPayments Method
GetPaymentTransactionById Method
GetPaymentTransactionByInitialId Method
GetPaymentTransactionsByIds Method
GetPendingTerminationRequest Method
GetPerformanceCategories Method
GetPerformanceCounter Method
GetPerformanceCounterInstance Method
GetPerformanceLog Method
GetPluginByConfigurationId Method
GetPluginById Method
GetPluginConfigurationById Method
GetPluginConfigurationByKey Method
GetPluginConfigurationSchema Method
GetPossibleStateRules Method
GetPossibleStates Method
GetPrepaidCreditAmountForAccount Method
GetPrepaidCreditBalance Method
GetPrepaidCreditRecordById Method
GetPrepaidCreditRecords Method
GetPrepaidCreditsRelatedToPayment Method
GetPriceListOwnerId Method
GetPriceListOwners Method
GetPromoCodes Method
GetProvisioningActionsForSubscriptions Method
GetProvisioningPackage Method
GetProvisioningService Method
GetProvisioningServices Method
GetReceiptInfo Method
GetRefundablePayments Method
GetRefundById Method
GetRefundedPayments Method
GetRefundOverview Method
GetRemainingRenewalPeriod Method
GetReportArchiveById Method
GetReportById Method
GetReportData Method
GetReportDataSourceById Method
GetResellerCommissionSummary Method
GetSearchableObjects Method
GetSetting Method
GetShopById Method
GetShopDetailsById Method
GetShopItemCategoryById Method
GetShopProducts Method
GetSubresellerAccounts Method
GetSubscriptionByFriendlyId Method
GetSubscriptionById Method
GetSubscriptions Method
GetSubscriptionsByFriendlyId Method
GetSubscriptionsByIdsAndLanguage Method
GetSubscriptionsForCustomer Method
GetSubscriptionsForRenewalPeriod Method
GetSummaryUsageReport Method
GetTasksToRunOverview Method
GetTaxResult Method
GetTaxRuleResult Method
GetTaxRuleResultBulk Method
GetTemplate Method
GetTemplates Method
GetTemplatesForExport Method
GetTemplatesForExportByReseller Method
GetThemeCustomization Method
GetUnsubscribeHashData Method
GetUpgradeGroup Method
GetUpgradeGroups Method
GetUpgradeOptions Method
GetUsageReport Method
GetUsageReportSubscription Method
GetVersionInfo Method
HasUnpaidInvoices Method
HeartBeat Method
InvoiceExists Method
IsAnyCampaignWithCodeActive Method
IsOverMaxDebt Method
IsPaymentPossible Method
IsPendingTermination Method
IsPendingTerminationBulk Method
IsPossibleState Method
IsPossibleToReactivate Method
IsQtyChangePossible Method
IsSubscriptionTerminationPossible Method
IsUpgradeableOrDowngradeable Method
ListAzureMarkupsForItem Method
ListBillingReports Method
ListBulkSendStatusesForCustomer Method
ListInvoicesForAutocredit Method
ListItemsForReseller Method
ListItemsWithDetails Method
ListLanguages Method
ListLogins Method
ListMailingLists Method
ListMessages Method
ListMessagesByCustomer Method
ListMessagesByUserAndLanguage Method
ListOperations Method
ListPackageConfigurations Method
ListPayFileRecords Method
ListPendingSubscriptionTerminationRequests Method
ListPlugins Method
ListProvisioningPackages Method
ListProvisioningServices Method
ListReportDataSources Method
ListResellersWithCustomPrices Method
ListResourceLocations Method
ListShopItemCategories Method
ListShopsByReseller Method
ListTerminationOrigins Method
ListUnpaidInvoices Method
MakeOrder Method
MakeOrderWithLoginToken Method
MakePayment Method
MarkMessageAsRead Method
ParsePaymentFile Method
ParsePaymentFileForReseller Method
PreviewTemplate Method
PrintCreditedInvoices Method
PrintCreditedInvoicesWithPrintOption Method
PrintInvoices Method
PrintInvoicesWithPrintOption Method
PrintReceiptsWithPrintOption Method
ProcessOrder Method
ProcessPayFileRecords Method
ProcessPublicOrder Method
PromoCodesGenerator Method
ProvisionSubscription Method
ProvisionSubscriptions Method
ProvisionSubscriptionsWithStateFilter Method
ReactivateAccounts Method
RefundCreditsForDiscountedInvoice Method
RenderReport Method
RenderReportArchive Method
RenderTemplates Method
ResellerAddExtraUsernameAccount Method
ResellerCheckEmail Method
ResellerCreateCustomer Method
ResellerCreatetOneTimeLoginToken Method
ResellerGetAccountForUser Method
ResellerGetAccountForUserWithDetails Method
ResellerGetAccountWithDetails Method
ResellerGetCustomerPackagesByEmail Method
ResellerGetExtraUsernameAccounts Method
ResellerGetInvoiceByNo Method
ResellerGetPaidAmount Method
ResellerHasExtraUsernameAccount Method
ResellerRemoveExtraUsernameAccount Method
ResellerSearchManagableAccounts Method
ResetProvisioningStatus Method
SaveAzureMarkups Method
SaveReportToArchive Method
Search Method
SearchAccountDetails Method
SearchBulkSendStatuses Method
SearchPerformanceLog Method
SearchProperty Method
SearchReportArchives Method
SearchReports Method
SearchScheduledTaskRuns Method
SearchScheduledTasks Method
SearchShopItems Method
SearchShops Method
SearchShopsDetails Method
SearchSubAccounts Method
SearchSubscriptions Method
SearchTasksToRun Method
SearchTaxProfiles Method
SearchTemplates Method
SendCreditedInvoices Method
SendInvoices Method
SendMail Method
SendMailToAccountOwner Method
Signup Method
TerminateAccount Method
TerminateAccountAfterRequest Method
TerminateSubscription Method
TestDataSourceQuery Method
UnsubscribeFromMailingList Method
UpdateAccount Method
UpdateAccountAddresses Method
UpdateAccountDetails Method
UpdateBillingReport Method
UpdateBulkSendJob Method
UpdateBulkSendStatus Method
UpdateCampaign Method
UpdateCreditedInvoice Method
UpdateCurrency Method
UpdateCustomerReminder Method
UpdateInvoice Method
UpdateItem Method
UpdateItemWithResellerPrices Method
UpdateMailingList Method
UpdateMessage Method
UpdateOrder Method
UpdatePackageConfiguration Method
UpdatePayFileRecord Method
UpdatePayment Method
UpdatePaymentProfile Method
UpdatePaymentTransaction Method
UpdatePaymentTransactionObject Method
UpdatePluginConfiguration Method
UpdatePluginConfigurationValueById Method
UpdateProvisioningPackage Method
UpdateProvisioningService Method
UpdateRefund Method
UpdateReportDataSource Method
UpdateResellerCommissionStatus Method
UpdateScheduledTask Method
UpdateScheduledTasks Method
UpdateSetting Method
UpdateShop Method
UpdateShopDetails Method
UpdateShopItem Method
UpdateShopItemCategory Method
UpdateSubscription Method
UpdateSubscriptionRenewalData Method
UpdateTaxProfile Method
UpdateTaxProfiles Method
UpdateTemplate Method
UpdateUpgradeGroup Method
UpgradeGroupMemberCheckDowngradeOption Method
UpgradeSubscription Method
UploadUsageReport Method
ValidateShop Method
ValidateVatNumber Method
Click or drag to resize

IAtomiaBillingApiCreateRefundFromPaymentIdChangeStatus Method

Refund payment and optionally create a credit invoice.

Namespace:  Atomia.Billing.Core.Sdk
Assembly:  Atomia.Billing.Core.Sdk (in Atomia.Billing.Core.Sdk.dll) Version: 18.10.7096.28998
Syntax
Copy
Refund CreateRefundFromPaymentIdChangeStatus(
	Guid paymentId,
	RefundStatusType initialStatus,
	bool createCreditedInvoice,
	bool updateInvoiceChangeStatusToSent
)

Parameters

paymentId
Type: SystemGuid
The payment identifier.
initialStatus
Type: Atomia.Billing.Core.Sdk.BusinessObjectsRefundStatusType
The initial refund status.
createCreditedInvoice
Type: SystemBoolean
If a credited invoice should be created or not.
updateInvoiceChangeStatusToSent
Type: SystemBoolean
If set to false then don't update status of the invoice connected to payment, if set to true then update it

Return Value

Type: Refund
The refund
See Also