Skip to main content

Search Account Credits

SearchAccountCredits​

This method returns information about account credits based on the filter provided to this method. The sorting property determines how the account credits will be sorted by direction and property.

Input​

SearchAccountCreditsRequest​

FieldURTypeDescription
StartIndex-*IntegerIndex of the first result.
EndIndex-*IntegerIndex of the last result.
SearchAccountCreditFilter**SearchAccountCreditFilterStructure for filtering search and narrowing down the result.
SearchAccountCreditSorting**SearchAccountCreditSortingStructure that contains information on how to sort items.

Output​

SearchAccountCreditsResponse​

FieldRTypeDescription
AccountCreditListItems*Array of AccountCreditListItemAccount credits that matched search criteria. See AccountCreditListItem.
ResultCount*IntegerNumber of account credits that matched the search criteria.

Structures​

AccountCreditListItem​

FieldURTypeDescription
ClientId**Long(7)ID that identifies a client in Svea Payments’s system.
ClientAccountCreditId**Long(10)Reference to a delivered account credit.
NationalIdNumber--String(12)Field for unique identifiers for customers in certain countries (e.g., Personnummer & organisationsnummer in Sweden). Will not be returned for Finnish clients.
CreatedDate--DateTimeDate when the account credit was created in Svea Payments’s system.
ContractNumber--Long(10)The contract number.
Amount--Decimal(18,2)Account credit amount.
CustomerName--String(40)The name of the customer.
SveaOrderId*-Long(10)Unique ID for the created order.
ClientOrderId--String(30)Order number from the client’s ordersystem.
Status--(String) AccountCreditStatusSee AccountCreditStatus.
CustomerType--CustomerTypeSee CustomerType.
CustomerCountryCode--String(2)A country code which defines where the customer is residing.
PaidToClientDate--DateTime
Currency--StringCurrency for the country the account credit was created for.

SearchAccountCreditFilter​

FieldRTypeDescription
AcceptedAccountCreditStatuses-AccountCreditStatusSee AccountCreditStatus.
Clientids-List of LongA list of client IDs to search account credits from.
AccountCreditIds-List of LongA list of account credit IDs to search for.
TextMatch-StringA free text string to search on account credit fields.
StartDate-DateTimeAccount credit creation date to search from.
EndDate-DateTimeAccount credit creation date to search to.
TextMatchType-TextMatchTypeSet the property to use for the free text search. If not provided, AllFields will be searched.

SearchAccountCreditSorting​

FieldRTypeDescription
SortDirection-SortDirectionSee SortDirection.
SortAccountCreditProperty-SortAccountCreditPropertyWhich property to sort on. Default is creation date.

Enumerations​

AccountCreditStatus​

ValueDescription
PendingApproval-
WaitingToBeSent-
Error-
SentToEconomySystem-
Cancelled-

CustomerType​

ValueDescription
Individual-
Company-

TextMatchType​

ValueDescription
AllFields-
SveaOrderId-
ClientOrderNumber-
NationalIdNumber-
ContractNumber-
AccountCreditId-

SortAccountCreditProperty​

ValueDescription
Amount-
CreationDate-
ContractNumber-
ClientId-
OrderId-
ClientAccountCreditId-
Last updated on