Search Payment Plans
SearchPaymentPlans
This method searches and retrieves payment plans based on the filter provided to the method.
Input
SearchPaymentPlansRequest
| Field | R | Type | Description |
|---|---|---|---|
| StartIndex | * | Integer | Index of first result. |
| EndIndex | * | Integer | Index of last result. |
| SearchPaymentPlanFilter | * | SearchPaymentPlanFilter | Filter for search. See SearchPaymentPlanFilter. |
| SearchPaymentPlanSorting | * | SearchPaymentPlanSorting | Field to sort the result. See SearchPaymentPlanSorting. |
Output
SearchPaymentPlansResponse
| Field | R | Type | Description |
|---|---|---|---|
| PaymentPlanListItems | * | Array of PaymentPlanListItem | Result of search. |
| ResultCount | * | Integer | Number of hits of a search. |
Structures
PaymentPlanListItem
| Field | R | Type | Description |
|---|---|---|---|
| CustomerType | - | CustomerType | See CustomerType. |
| CustomerCountryCode | - | String(2) | Two-letter country code. |
| ClientOrderId | - | String | Order number from the client’s ordersystem. |
| ApprovedDate | * | DateTime | Date when the payment plan was approved. |
| Status | * | String (PaymentPlanStatus) | See PaymentPlanStatus. |
| Amount | * | Decimal(15,2) | Payment plan amount. |
| PaidDate | - | Nullable<DateTime> | Date when the payment plan was paid. |
| NationalIdNumber | * | String(12) | Unique identifier for customers (e.g., Personnummer & organisationsnummer in Sweden). Not returned for Finnish clients. |
| SveaOrderId | * | Long | Unique ID for the created order. Used for any further order webservice requests. |
| ClientId | * | Long(7) | ID that identifies a client in Svea Payments system. |
| ContractLengthInMonths | * | Integer | - |
| ContractNumber | * | Long | Reference to a payment plan. |
| CustomerName | * | String | - |
SearchPaymentPlanFilter
| Field | R | Type | Description |
|---|---|---|---|
| AcceptedStatus | - | PaymentPlanStatus | See PaymentPlanStatus. |
| TextMatch | - | String | Search text. |
| TextMatchType | - | TextMatchType | Property to use for the free text search. Use in combination with TextMatch for more efficient search. If not provided, AllFields is used. |
SearchPaymentPlanSorting
| Field | R | Type | Description |
|---|---|---|---|
| SortDirection | - | SortDirection | See SortDirection. |
| SortPaymentPlanProperty | - | SortPaymentPlanProperty | Possible sorting field. |
Enumerations
PaymentPlanStatus
| Value | Description |
|---|---|
| Cancelled | The payment plan has been cancelled. |
| Error | An error occurred. |
| WaitingToBeSent | The payment plan is waiting to be sent. |
| WaitingForContract | The payment plan awaiting contract. |
| Running | The payment plan is currently active. |
| Finished | The payment plan has been completed. |
TextMatchType
| Value | Description |
|---|---|
| AllFields | Searches across all available fields. |
| SveaOrderId | Searches by Svea order identifier. |
| ClientOrderNumber | Searches by client order number. |
| NationalIdNumber | Searches by national ID number. |
| ContractNumber | Searches by contract number. |
SortPaymentPlanProperty
| Value | Description |
|---|---|
| ApprovedDate | Sorts by the date the payment plan was approved. |
| Amount | Sorts by the total amount of the payment plan. |
| ContractNumber | Sorts by the contract number. |
| PaidDate | Sorts by the date the payment plan was paid. |
| SveaOrderId | Sorts by the Svea order identifier. |
| CustomerName | Sorts by the name of the customer. |
| Status | Sorts by the current status of the payment plan. |
| NationalIdNumber | Sorts by the national ID number. |
| ClientOrderId | Sorts by the client’s order identifier. |
| ContractLengthMonths | Sorts by the length of the contract in months. |
CustomerType
| Value | Description |
|---|---|
| Individual | The customer is a private individual. |
| Company | The customer is a business entity. |