Adminservice API Documentation
Overview
Endpoints
Production: https://webpayadminservice.svea.com/AdminService.svc
Test: https://webpayadminservicestage.svea.com/AdminService.svc
Endpoint WSDL
Production: https://webpayadminservice.svea.com/AdminService.svc?wsdl
Test: https://webpayadminservicestage.svea.com/AdminService.svc?wsdl
This is where you should direct requests to the web service. Requests should be made with SOAP over HTTPS using SOAP 1.2 with the wrapped document-literal format and with a SOAP action specified.
For access to test accounts, please contact Svea Payments.
Supported Service Calls
The service currently supports the following calls:
- GetOrders
- CancelOrderRows
- CancelPaymentPlanAmount
- CancelPaymentPlanRows
- CancelOrder
- DeliverPartial
- DeliverOrders
- SearchOrders
- AddOrderRows
- UpdateOrderRows
- SearchInvoices
- GetInvoices
- CreditInvoiceRows
- SearchPaymentPlans
- UpdateOrder
- GetSumOfOrderAmount
- GetSumOfInvoiceAmount
- GetSumOfPaymentPlanAmount
- ApproveInvoice
- CreateOrder
- CreateApprovedOrder
- ReleasePendingOrder
- GetFinancialReport
- GetInvoiceReport
- GetAccountingReport
- ChangeInvoiceDueDate
- CancelAccountCreditAmount
- CancelAccountCreditRows
- GetClientId
- ExtendOrder
- GetInvoicePdfLink
- GetInvoicesWithChangedDueDate
- GetOrderEvents
- SearchAccountCredits
- GetAccountCredits
- GetRegressionReport
- GetPaymentPlanReport
- GetInvoiceJournalReport
- GetSpecificationReport
- GenerateAccountCreditRegressReport
- GenerateAccountingAgreementType25Report
Enumerations
Enumerations are returned as strings to the client to ensure backward compatibility. New enumeration types may be added, and the client-side implementation must be constructed to allow new, unseen types received from the web service.
Order Rows
For individual customers, we highly recommend that you:
- Add order rows where the amount of PricePerUnit and DiscountAmount (if any) is including VAT, together with their appropriate flags PriceIncludingVat and DiscountAmountIncludingVat set to true.
For company customers, we highly recommend that you do the opposite:
- Add order rows where the amount of PricePerUnit and DiscountAmount (if any) is excluding VAT, together with their appropriate flags PriceIncludingVat and DiscountAmountIncludingVat set to false.
Disclaimer
This documentation is subject to continuous updates. Please make sure you are using the latest version. If you have any questions, please contact support-payments@svea.com.
Methods
Abbreviations and Types Used in the Description
- U: Unique
- R: Required
Types
- Text: Any plain text. Remember that certain characters (like
&
) have special meaning in XML and need to be either escaped or encased in a CDATA block. - Integer: Number without decimals (e.g.,
10
,42
,-92
). - Long: A longer integer.
- Decimal: A decimal number (e.g.,
10.65
or-43.34
).- When there is a parenthesis in the decimal declaration (e.g.,
Decimal (11,2)
), it means that the field supports 11 significant numbers and 2 decimals.
- When there is a parenthesis in the decimal declaration (e.g.,
- The number following text fields (e.g.,
Text (2)
) means that the maximum length for that field is 2.
Common to All Requests
BasicRequest
Field | R | Type | Description |
---|---|---|---|
Authentication | * | Authentication | Login information. |
Settings | Collection of Settings | Optional settings to be used for the call. |
Common to All Responses
BasicResponse
Field | R | Type | Description |
---|---|---|---|
ResultCode | * | Integer | See ResultCode table |
ErrorMessage | - | String | When ResultCode indicates an error, this may be populated with a message that describes the error. |
Structures
Authentication
Field | R | Type | Description |
---|---|---|---|
Username | * | String | User name |
Password | * | String | Password |
Setting
Field | R | Type | Description |
---|---|---|---|
Name | * | String | The name of the setting |
Value | * | String | The value of the setting |