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
Field | U | R | Type | Description |
---|---|---|---|---|
StartIndex | - | * | Integer | Index of the first result. |
EndIndex | - | * | Integer | Index of the last result. |
SearchAccountCreditFilter | * | * | SearchAccountCreditFilter | Structure for filtering search and narrowing down the result. |
SearchAccountCreditSorting | * | * | SearchAccountCreditSorting | Structure that contains information on how to sort items. |
Output
SearchAccountCreditsResponse
Field | R | Type | Description |
---|---|---|---|
AccountCreditListItems | * | Array of AccountCreditListItem | Account credits that matched search criteria. See AccountCreditListItem. |
ResultCount | * | Integer | Number of account credits that matched the search criteria. |
Structures
AccountCreditListItem
Field | U | R | Type | Description |
---|---|---|---|---|
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 | - | - | DateTime | Date 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) AccountCreditStatus | See AccountCreditStatus. |
CustomerType | - | - | CustomerType | See CustomerType. |
CustomerCountryCode | - | - | String(2) | A country code which defines where the customer is residing. |
PaidToClientDate | - | - | DateTime | |
Currency | - | - | String | Currency for the country the account credit was created for. |
SearchAccountCreditFilter
Field | R | Type | Description |
---|---|---|---|
AcceptedAccountCreditStatuses | - | AccountCreditStatus | See AccountCreditStatus. |
Clientids | - | List of Long | A list of client IDs to search account credits from. |
AccountCreditIds | - | List of Long | A list of account credit IDs to search for. |
TextMatch | - | String | A free text string to search on account credit fields. |
StartDate | - | DateTime | Account credit creation date to search from. |
EndDate | - | DateTime | Account credit creation date to search to. |
TextMatchType | - | TextMatchType | Set the property to use for the free text search. If not provided, AllFields will be searched. |
SearchAccountCreditSorting
Field | R | Type | Description |
---|---|---|---|
SortDirection | - | SortDirection | See SortDirection. |
SortAccountCreditProperty | - | SortAccountCreditProperty | Which property to sort on. Default is creation date. |
Enumerations
AccountCreditStatus
Value | Description |
---|---|
PendingApproval | - |
WaitingToBeSent | - |
Error | - |
SentToEconomySystem | - |
Cancelled | - |
CustomerType
Value | Description |
---|---|
Individual | - |
Company | - |
TextMatchType
Value | Description |
---|---|
AllFields | - |
SveaOrderId | - |
ClientOrderNumber | - |
NationalIdNumber | - |
ContractNumber | - |
AccountCreditId | - |
SortAccountCreditProperty
Value | Description |
---|---|
Amount | - |
CreationDate | - |
ContractNumber | - |
ClientId | - |
OrderId | - |
ClientAccountCreditId | - |