ADMINISTRATION SERVICE API 1.12 SveaWebPay

Transcription

1 ADMINISTRATION SERVICE API 1.12 SveaWebPay

2 2 (36) Table of Contents Revisions... 7 Overview... 8 Enumerations... 8 Disclaimer... 8 Methods... 9 Common to all requests... 9 Common to all responses... 9 Structures... 9 Authentication... 9 Setting... 9 GetOrders GetOrdersRequest GetOrdersResponse Structures GetOrderInformation Order CustomerIdentity PaymentPlanDetails CreditReportStatus NumberedOrderRow PendingReason Enumerations OrderType OrderDeliveryStatus OrderStatus OrderRowStatus CustomerType CancelOrderRows CancelOrderRowRequest CancelOrderRowResponse CancelOrder CancelOrderRequest CancelOrderResponse DeliverPartial PartialDeliveryRequest DeliveryResponse Enumerations InvoiceDistributionType... 15

3 3 (36) Structures DeliverOrderResult DeliverOrders DeliveryRequest DeliveryResponse Structures DeliverOrderInformation SearchOrders SearchOrdersRequest SearchResponse Structures SearchOrderFilter SearchOrderSorting OrderListItem Enumerations SortDirection SortOrderProperty AddOrderRows AddOrderRowsRequest AddOrderRowsResponse Structures OrderRow UpdateOrderRows UpdateOrderRowsRequest UpdateOrderRowsResponse Structures NumberedOrderRow SearchInvoices SearchInvoicesRequest SearchInvoicesResponse Structures InvoiceListItem Enumerations InvoicePaymentStatus InvoiceType GetInvoices

4 4 (36) GetInvoicesRequest GetInvoicesResponse Structures GetInvoiceInformation Invoice IndividualIdentity CompanyIdentity CreditInvoiceRows CreditInvoiceRequest DeliveryResponse SearchPaymentPlans SearchPaymentPlanRequest SearchPaymentPlanResponse Structures SearchPaymentPlanFilter SearchPaymentPlanSorting Enumerations PaymentPlanStatus SortPaymentPlanProperty UpdateOrder UpdateOrderRequest UpdateOrderResponse GetSumOfOrderAmount SumOfOrderAmountRequest SumOfAmountResponse GetSumOfInvoiceAmount SumOfInvoiceAmountRequest SumOfAmountResponse GetSumOfPaymentPlanAmount SumOfPaymentPlanAmountRequest SumOfAmountResponse ApproveInvoice

5 5 (36) ApproveInvoiceRequest ApproveInvoiceResponse CreateOrder CreateOrderRequest CreateOrderResponse Structures CreateOrderInformation Address CreatePaymentPlanDetails CreateOrderResult ReleasePendingOrder ReleasePendingRequest ReleasePendingResponse Enumerations PendingType GetFinancialReport GetFinancialReportRequest GetFinancialReportResponse Structures FinancialReportHeader FinancialReportRow GetInvoiceReport GetInvoiceReportRequest GetInvoiceReportResponse InvoiceReportRow GetAccountingReport GetAccountingReportRequest GetAccountingReportResponse AccountingReportRow GetRegressionReport GetRegressionReportRequest GetRegressionReportResponse RegressionReportRow GetPaymentPlanReport... 32

6 6 (36) GetPaymentPlanReportRequest GetPaymentPlanReportResponse PaymentPlanReportRow GetInvoiceJournalReport GetInvoiceJournalReportRequest GetInvoiceJournalReportResponse InvoiceJournalReportRow GetInvoicePdfLink GetInvoicePdfLinkRequest PdfLinkResponse GetInvoicesWithChangedDueDate GetInvoicesWithChangedDueDateRequest GetInvoicesWithChangedDueDateResponse InvoicesWithChangedDueDate ChangeInvoiceDueDate ChangeInvoiceDueDateRequest ChangeInvoiceDueDateResponse Result Code Table... 35

7 7 (36) Revisions Added argument to UpdateOrder Added method ChangeInvoiceDueDate. Corrected some method descriptions and standardized the format of the descriptions Added fields capital, rate, fee to RegressionReportRow. Changed fields for PaymentPlanReportRow Added method GetInvoicesWithChangedDueDate Added method GetInvoiceJournalReport Added ReportingDate to AccountingReportRow Added methods GetRegressionReport, GetPaymentPlanReport Added method GetInvoicePdfLink Updated with new layout Changed documentation name Added methods GetFinancialReport, GetInvoiceReport, GetAccountingReport Added option PaidAmount i SumOfPaymentPlanAmountRequest Changed PayedToClientDate to PaidToClientDate, and Payed to Paid Changed RemainingAmount to Amount in SearchOrderResponse Added OrderDeliveryAddress to CreateOrderInformation Added end point addresses First version.

8 8 (36) Overview Endpoint: Production: Test: Endpoint WSDL: Production: Test: This is where requests to the web service is to be directed. Requests should be made with SOAP over HTTPS using SOAP 1.1 with the wrapped document-literal format and with a SOAP action specified. Please contact SveaWebPay for access to test accounts. The service currently supports the following calls: - GetOrders - CancelOrderRows - CancelOrder - DeliverPartial - DeliverOrders - SearchOrders - AddOrderRows - UpdateOrderRows - SearchInvoices - GetInvoices - CreditInvoiceRows - SearchPaymentPlans - UpdateOrder - GetSumOfOrderAmount - GetSumOfInvoiceAmount - GetSumOfPaymentPlanAmount - ApproveInvoice - CreateOrder - ReleasePendingOrder - GetFinancialReport - GetInvoiceReport - GetAccountingReport - ChangeInvoiceDueDate If you have questions regarding the integration with SveaWebPay please send an to: support-webpay@sveaekonomi.se 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. Disclaimer This documentation is subject to continuous updates. Please make sure you are using the latest version. Contact support-webpay@sveaekonomi.se with questions regarding this documentation.

9 9 (36) Methods Abbreviations and Types used in the description U: Unique R: Required Types o 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 o Integer: Number without decimals. Like 10, 42, -92 o Long: A longer integer. o Decimal: Decimal number. Like or o When there is an parentheses in the Decimal declaration like Decimal (11,2) means that the field supports 11 significant numbers and 2 decimals. o The number following Text fields like Text (2) means that the maximum length for this field is 2. Common to all requests Authentication * Authentication Login information. Settings Collection of Settings Optional settings to be used for this call. Common to all responses ResultCode * Integer See ResultCode table. (Page 35) ErrorMessage String When ResultCode returnes error code this might be populated with a message that describes the error. Structures Authentication Username * String User name Password * String Password Setting Name * String The name of the setting Value * String The value of the setting

10 10 (36) GetOrders This method is used fetch specific orders from SveaWebPay system and their order rows. GetOrdersRequest OrdersToRetrieve * Collection of GetOrderInformation Information about the orders to retrieve GetOrdersResponse Orders Collection of Order The orders that were requested. Structures GetOrderInformation SveaOrderId * Long(10) Unique Id for the created order. Used for any further order webservice requests. OrderType OrderType See Enumeration. (Page 12). Not required for EUclients. ClientId * Long(7) Id that identifies a client in SveaWebPay Order ClientOrderId String(30) Order number from client s order SveaOrderId * * Long(10) Unique Id for the created order. Used for any further order webservice requests. OrderDeliveryStatus * (String)OrderDeliveryStatus See Enumeration. (Page 12) OrderStatus * (String)OrderStatus See Enumeration. (Page 12) OrderType * (String)OrderType See Enumeration. (Page 12) CreatedDate * DateTime Date when order was first created. Customer * CustomerIdentity Shipping address. CustomerId Nullable<Long> Customer id that is created by SveaWebPay CustomerReference String(30) Customer Reference. (Gets printed on the invoice.) ChangeDate DateTime Date when order status was changed, e.g when order was delivered. Currency * String(3) Country currency. SveaWillBuy * Boolean Describes whether SveaWebPay will buy the order or just administrate it. Notes * String(200) Text on order created by client. ClientId * * Long(7) Id that identifies a client in sveawebpay

11 11 (36) PaymentPlanDetails PaymentPlanDetails Only applicable for paymentplan ordertype. IsPossibleToAdminister * Boolean CreditReportStatus CreditReportStatus Tells if order is approved or not. Please see Structures for further explanation about this type. Not sent if no credit decision has been made (e.g., manual administration) OrderRows * Collection of Order rows for a order. NumberedOrderRow IsPossibleToCancel * Boolean Tells if order can be cancelled or not. PendingReasons Collection of PendingReasons Reasons to why the order is pending. Please see Structures for further explanation about this type. CustomerIdentity NationalIdNumber * String Field for entering unique identifiers for customers in certain countries. (Example: Personnummer & organisationsnummer in Sweden) String A valid address to the customer. PhoneNumber String Customer s phone number. IpAddress String Customer s IP-address FullName * String Full name of the customer. Either first name + family name or company name. Street * String Customer s street address. CoAddress String Customer co-address. ZipCode * String The complete zip code of the Customer. HouseNumber String House number (only applicable in certain countries). Locality * String Customer s town of residence. CountryCode * String (2) A country code which defines where the customer is residing. CustomerType * CustomerType See Enumeration (Page 12) IndividualIdentity IndividualIdentity Only if the CustomerType is Individual. CompanyIdentity CompanyIdentity Only if the CustomerType is Company. PaymentPlanDetails ContractNumber * Nullable<Long> Contract number of a specific contract. ContractLengthMonths Integer

12 12 (36) CreditReportStatus CreationDate * DateTime Date of order credit decision. Accepted * Boolean Tell s if credit decision is accepted or not. NumberedOrderRow RowNumber * Long(3) ArticleNumber String(10) Article number of the product Description String(40) Description of the product. PricePerUnit * Decimal(18,2) Price per unit of product. ( Excluding Vat ) Unit String(3) Short description of unit. (Ea.) etc. VatPerCent * Decimal(2,0) Percent of Vat (0 99) DiscountPercent * Decimal Percent of Discount (0 99) Status (String)OrderRowStatus See Enumeration (Page 12.) InvoiceId * Nullable<Long> Id to invoice if order have been delivered. CreditInvoiceId * Nullable<Long> Reference to invoice to credit. PendingReason PendingType * (String)PendingType See Enumerations (p. 29) CreatedDate * String(10) Date where reason was created. Enumerations OrderType Invoice PaymentPlan OrderDeliveryStatus Created PartiallyDelivered Delivered Cancelled OrderStatus Created Pending Active Denied Error

13 13 (36) OrderRowStatus NotDelivered Delivered Cancelled CustomerType Individual Company CancelOrderRows CancelOrderRowRequest SveaOrderId * Long(10) Unique Id for the created order. Used for any further order webservice requests. OrderType OrderType See Enumeration. (Page 12). Not required for EUclients. ClientId * Long(7) Id that identifies a client in sveawebpay OrderRowNumbers * Collection of Long The row numbers that should be cancelled CancelOrderRowResponse Empty field CancelOrder The method cancels a specific order in webpay This means that no further action is available to this order. CancelOrderRequest SveaOrderId * Long(10) Unique Id for the created order. Used for any further order webservice requests. OrderType OrderType See Enumeration. (Page 12). Not required for EUclients. ClientId * Long(7) Id that identifies a client in sveawebpay

14 14 (36) CancelOrderResponse Empty field

15 15 (36) DeliverPartial This method partially delivers an order. An invoice or payment plan is created with the sum of the amount of the order rows sent to this method. The available amount is decreased by the same amount. Please note that only invoices can be partially delivered. Any payment plan being delivered with this function will be fully delivered with the only exclusion being cancelled order rows. PartialDeliveryRequest OrderToDeliver * DeliverOrderInformation See Structure (Page 16) RowNumbers * List<Long> List of order rows to be delivered. InvoiceDistributionType * InvoiceDistributionType See Enumeration (Page 15) DeliveryResponse OrdersDelivered * List<DeliverOrderResult> Enumerations InvoiceDistributionType Post Invoice is sent by mail. Invoice is sent by . Structures DeliverOrderResult SveaOrderId * * Long(10) Unique Id for the created order. Used for any further order webservice requests. ClientOrderId String(30) Order number from client s order ClientId * * Long(7) Id that identifies a client in sveawebpay OrderType * OrderType See Enumeration. (Page 12) DeliveryReferenceNumber * Long(10) For OrderType Invoice invoice id, PartPayment contract id. DeliveredAmount * Decimal(11,2) Delivered order amount.

16 16 (36) DeliverOrders This method creates invoices or payment plans based on the orders sent to this method. DeliveryRequest OrdersToDeliver * Collection of DeliverOrderInformation See Structure (Page 16) InvoiceDistributionType * InvoiceDistributionType See Structure (Page 15) DeliveryResponse OrdersDelivered * Array of DeliverOrderResult See Structure (Page 15) Structures DeliverOrderInformation ClientId * Long(7) Id that identifies a client in sveawebpay SveaOrderId * Long(10) Unique Id for the created order. Used for any further order webservice requests. OrderType OrderType See Enumeration. (Page 12). Not required for EU-clients. SearchOrders This method searches and returns orders based on the filter information provided to this method. Start index and end index is used to select a subset of results to be used for paging. The sorting structure describes how the results should be sorted. SearchOrdersRequest StartIndex * Integer Index of the first result EndIndex * Integer Index of the last result SearchOrderFilter * SearchOrderFilter Filter for filtering search and narrowing down the result. SearchOrderSorting * SearchOrderSorting To sort the data. SearchResponse OrderListItems * Array of OrderListItems List of search results. ResultCount * Integer Number of hit s after a search.

17 17 (36) Structures SearchOrderFilter AcceptedDeliveryStatus List of OrderDeliveryStatus See Enumeration. (Page 12) AcceptedOrderStatus List of OrderStatus See Enumeration. (Page 12) TextMatch String Free text match on order id, birth date etc. StartDate DateTime The earliest creation date/time of the order searched for EndDate DateTime The latest creation date/time of the order searched for SearchOrderSorting SortDirection SortDirection Which way to sort. Ascending or Descending. SortOrderProperty SortOrderProperty Which field to sort on. OrderListItem ClientOrderId String(30) Order number from client s order CreatedDate DateTime Date when order was first created. Status (String)OrderStatus See Enumeration. (Page 12) DeliveryStatus (String)DeliveryStatus See Enumeration. (Page 12) Amount Decimal(11,2) The order amount. OrderType (String)OrderType See Enumeration. (Page 12) NationalIdNumber String Field for entering unique identifiers for customers in certain countries. (Example: Personnummer & organisationsnummer in Sweden). For countries W/O this, birthdate is returned instead. SveaOrderId Long(10) Unique Id for the created order. Used for any further order webservice requests. ClientId Long(7) Id that identifies a client in sveawebpay CreditApproved Boolean Tell s if credit was approved by SveaWebPay or not. CreditRejectionMessage String(70) Tell s why a credit was rejected by SveaWebPay. ChangeDate Nullable of DateTime Date when order change status.

18 18 (36) CancelledDate Nullable of DateTime Date when order was cancelled. CustomerName String Name on customer associated with order. Enumerations SortDirection Ascending Descending SortOrderProperty CreatedDate RemaningAmount ClientOrderId CreditApproved SveaOrderId CustomerName Status NationalIdNumber OrderType AddOrderRows This method is used to add order rows to an order. If the new order amount exceeds the remaining amount on order a new credit control is made. AddOrderRowsRequest SveaOrderId * Long(10) Unique Id for the created order. Used for any further order webservice requests. OrderType OrderType See Enumeration. (Page 12). Not required for EU-clients. ClientId * Long(7) Id that identifies a client in sveawebpay OrderRows * Array of OrderRow Order rows to add to a order. AddOrderRowsResponse Structures OrderRow ArticleNumber String (10) Article number of the product Description String (40) Description of the product. PricePerUnit * Decimal(18,2) Price per unit of product.

19 19 (36) ( Excluding Vat ) NumberOfUnits * Decimal(18,2) Unit String (3) Short description of unit. (Ea.) etc. VatPercent * Decimal(18, 2) Percent of Vat ( 0 99 ) DiscountPercent * Decimal(18, 2) Percent of Discount ( 0 99 ) UpdateOrderRows This method updates order rows on existing order in SveaWebPay s If the new order amount exceeds the remaining amount on order a new credit control is made. UpdateOrderRowsRequest SveaOrderId * Long(10) Unique Id for the created order. Used for any further order webservice requests. OrderType OrderType See Enumeration. (Page 12). Not required for EU-clients ClientId * Long(7) Id that identifies a client in SveaWebPay UpdateOrderRows * Array of NumberedOrderRow Order rows for a order. See structure (Page 12) UpdateOrderRowsResponse Structures NumberedOrderRow Inherits from OrderRow RowNumber * Long(4) Status OrderRowStatus This is returned by SveaWebPay system and should not be populated in UpdateOrderRowsRequest. InvoiceId Nullable of Long(10) Reference to Invoice if OrderType Invoice. CreditInvoiceId Nullable of Long(10) Reference to credit invoice if OrderType Invoice.

20 20 (36) SearchInvoices This method returns information about invoices based on filter provided to this method. SearchInvoicesRequest StartIndex * Integer Index of the first result EndIndex * Integer Index of the last result SearchInvoiceFilter * SearchInvoiceFilter Filter for filtering search and narrowing down the result. SearchInvoiceSorting * SearchInvoiceSorting To sort the data. SearchInvoicesResponse InvoiceListItems * Array of InvoiceListItem Invoices that matched search criteria. See Structure (Page 20) ResultCount * Integer Shows how many invoices matched search criteria. Structures InvoiceListItem ClientId * * Long(7) Id that identifies a client in sveawebpay InvoiceId * * Long(10) Reference to a Invoice. NationalIdNumber String(12) Field for entering unique identifiers for customers in certain countries. (Example: Personnummer & organisationsnummer in Sweden) InvoiceDate DateTime Date when the invoice is created in SveaWebPay DueDate DateTime Due date for the invoice; when SveaWebPay wants the invoice to be paid. PaidToClientDate Nullable of DateTime Date when SveaWebPay paid/pays client for invoices. Amount Decimal(15,2) Invoice amount.

21 21 (36) CreditedAmount Decimal(15,2) Amount that have been credited for a invoice. SveaHasBought Boolean True if SveaWebPay bought invoice, otherwise false. CustomerName String(40) Name of customer invoice is sent to. SveaOrderId * Long(10) Unique Id for the created order. Used for any further order webservice requests. ClientOrderId String(30) Order number from client s order Status (String)InvoicePaymentStatus See Enumeration (Page 21) Type InvoiceType See Enumeration (Page 21) Enumerations InvoicePaymentStatus PendingApproval Sent Paid Overdue Reminded DebtCollection Cancelled InvoiceType Debit Credit GetInvoices This method returns information about a specific invoice. GetInvoicesRequest InvoicesToRetrieve * Collection of GetInvoiceInformation Describes the invoices to retrieve GetInvoicesResponse Invoices * Collection of Invoice The invoices that match the request

22 22 (36) Structures GetInvoiceInformation InvoiceId * Long(10) Reference to a Invoice. ClientId * Long Id that identifies a client in SveaWebPay Invoice ClientId * * Long(7) Id that identifies a client in sveawebpay InvoiceId * Long(10) Reference to a Invoice. CreditedAmount * Decimal(18,2) The total amount that is credited on this invoice. UnmatchedCreditAmount Decimal(18,2) The amount that is credited on this invoice, that does not match any of the invoice rows. InvoiceDate * DateTime Date when the invoice is created in SveaWebPay DueDate * DateTime Due date for the invoice; when SveaWebPay wants the invoice to be paid. EarliestPossibleNewDueDate Nullable of DateTime The earliest possible new due date that the invoice may be set to. If null, changing the invoice date is not possible. LatestPossibleNewDueDate Nullable of DateTime The latest possible new due date that the invoice may be set to. If null, changing the invoice date is not possible. PaidToClientDate Nullable of DateTime Date when SveaWebPay paid/pays client for invoices. Amount * Decimal(15,2) Invoice amount. SveaOrderId * Long(10) Unique Id for the created order. Used for any further order webservice requests. SveaHasBought * Boolean True if SveaWebPay bought invoice, otherwise false. Currency * String Currency of the country invoice was created for. SveaOrderId * Long(10) Unique Id for the created order. Used for any further order webservice requests. ClientOrderId String(30) Order number from client s order Status * (String)InvoicePaymentStatus See Enumeration (Page 21)

23 23 (36) Type * InvoiceType See Enumeration (Page 21) CustomerReference String(32) Reminder1Date Nullable of DateTime Date of the first reminder. Reminder2Date Nullable of DateTime Date of the second reminder. DeboCollectionDate Nullable of DateTime Date when invoice went to debt collection. CreditedDate Nullable of DateTime Date when invoice been cretited. Notes String(200) Note on invoice from client to customer. ClientReference String(32) Customer * CustomerIdentity Identity of the customer. See structure (Page 11) CustomerId Nullable of Long() Customer id that is created by SveaWebPay InvoiceRows * Array of NumberedOrderRow See Structure (Page 12) CreditApproved * Boolean True if credit was accepted, false otherwise. IsPossibleToCancel * Boolean IndividualIdentity FirstName * String LastName * String Initials String Only used in NL, voorletters BirthDate String Person date of birth in format YYYYMMDD. (Required for DE and NL) CompanyIdentity CompanyIdentification String Not in use. CompanyVatNumber String Company Vat number (Required for DE and NL) CreditInvoiceRows This method creates a credit invoice based on the invoice rows sent to it. CreditInvoiceRequest InvoiceId * Long(10) Reference to a Invoice. ClientId * Long(7) Id that identifies a client in SveaWebPay RowNumbers * Array of Long InvoiceDistributionType * InvoiceDistributionType See Enumeration (Page 15) NewCreditInvoiceRows Array of OrderRow See Structure (Page 18)

24 24 (36) DeliveryResponse See Structure (Page 16) SearchPaymentPlans This method searches and retrieves payment plans based on filter sent to this method. SearchPaymentPlanRequest StartIndex * Integer Index of first result EndIndex * Integer Index of last result SearchPaymentPlanFilter * SearchPaymentPlanFilter Filter for search. See Structure (Page 24) SearchPaymentPlanSorting * SearchPaymentPlanSorting Field to sort the result. See Structure (Page 24) SearchPaymentPlanResponse PaymentPlanListItems * PaymentPlanListItem Result of search. ResultCount * Integer Number of hits of a search. Structures SearchPaymentPlanFilter AcceptedStatus PaymentPlanStatus See Enumeration (Page 24) TextMatch String Search text. SearchPaymentPlanSorting SortDirection SortDirection See Enumeration (Page 18) SortPaymentPlanProperty SortPaymentPlanProperty Possible sorting data. Enumerations PaymentPlanStatus Cancelled Error WaitingToBeSent WaitingForContract Running Finished

25 25 (36) SortPaymentPlanProperty ApprovedDate Amount ContractNumber PaidDate SveaOrderId CustomerName Status NationalIdNumber ClientOrderId ContractLengthMonths UpdateOrder This method is used to update certain information on an existing order. It will update Notes and ClientOrderNumber; any field not set to null. UpdateOrderRequest SveaOrderId * Long(10) Unique Id for the created order. Used for any further order webservice requests. OrderType OrderType See Enumeration (Page 12). Not required for EU-clients. ClientId * Long(7) Id that identifies a client in SveaWebPay Notes String(200) Note on invoice from client to customer. ClientOrderNumber String UpdateOrderResponse GetSumOfOrderAmount This method returns the total amount and total count of orders in SveaWebPay system based on filter sent to this method. SumOfOrderAmountRequest SearchOrderFilter * SearchOrderFilter See Structures (Page 17)

26 26 (36) SumOfAmountResponse Amount * Decimal Total amount of order s in search. Count * Integer Number of orders fetched in search. GetSumOfInvoiceAmount This method returns the total amount and total count of invoices in SveaWebPay system based on filter sent to this method. SumOfInvoiceAmountRequest SearchInvoiceFilter * SearchInvoiceFilter See Structures (Page 17) SumOfAmountResponse See (Page 26) GetSumOfPaymentPlanAmount This method returns the total amount and total count of payment plans in SveaWebPay system based on filter sent to this method. SumOfPaymentPlanAmountRequest SearchPaymentPlanFilter * SearchPaymentPlanFilter See Structures (Page 24) ReturnPaidToClientAmount Boolean If true, only the amount paid to the client is used. If false, the total amount of each paymentplan is used. SumOfAmountResponse See (Page 26)

27 27 (36) ApproveInvoice This method approves an invoice for delivery. ApproveInvoiceRequest ClientId * Long Id that identifies a client in SveaWebPay InvoiceId * Long Id of the invoice ApproveInvoiceResponse CreateOrder This method creates an invoice or payment plan order in the CreateOrderRequest ClientId Long Id that identifies a client in SveaWebPay Required if account have several clients of this order type. OrderInformation * CreateOrderInformation Information needed to create the order CreateOrderResponse CreateOrderResult CreateOrderResult The result of the operation OrderRows Collection of NumberedOrderRow The order rows in the request, decorated with a order row number. Structures CreateOrderInformation ClientOrderNumber String Order number from client s order OrderRows * Collection of OrderRows The order s order rows CustomerIdentity * CustomerIdentity The id details of the customer OrderDate * DateTime Date of the order AddressSelector String Used to select a

28 28 (36) specific address returned from GetAddress CustomerReference String OrderType * OrderType Invoice or PaymentPlan OrderDeliveryAddress Address Order delivery address, if other than address provided in CustomerIdentity. CreatePaymentPlanDetails CreatePaymentPlanDetails Required if order type is payment plan Address FullName * String Full name of the customer. Either first name + family name or company name. Street * String Customer s street address. CoAddress String Customer co-address. ZipCode * String The complete zip code of the Customer. HouseNumber String House number (only applicable in certain countries). Locality * String Customer s town of residence. CountryCode * String (2) A country code which defines where the customer is residing. CreatePaymentPlanDetails CampaignCode Long What campaigncode to use. Either campaign code or fixed monthly amount must be entered. CoCustomerIdentity CustomerIdentity Additional customer if applicaple SendAutomaticGiroPaymentForm Bool If AutoGiro payment form should be sent to customer FixedMonthlyAmount Decimal(18, 2) The desired amount to pay each month, including notification fee. CreateOrderResult SveaOrderId Long The order id OrderType String Invoice or PaymentPlan SveaWillBuyOrder Bool True if Svea agrees to buy this order/invoice Amount Decimal(18, 2) The total order amount CustomerIdentity CustomerIdentity Identity of the customer ExpirationDate DateTime The order s expiration date

29 29 (36) ReleasePendingOrder This method removes a pending reason from the order. If the order no longer has any pending reasons, it will change status to Active. Currently only supported for EU-clients. ReleasePendingRequest ClientId * Long Id that identifies a client in SveaWebPay SveaOrderId * Long The order id PendingType * String The pending type to remove. See Enumerations (p. 29) ReleasePendingResponse Enumerations PendingType SMSOnHighAmount UseOfDeliveryAddress GetFinancialReport This method retrieves a financial report for a given period of time. GetFinancialReportRequest ClientId * Long Id that identifies a client in SveaWebPay FromDate * DateTime The start of the report period. ToDate * DateTime The end of the report period. GetFinancialReportResponse ReportHeader FinancialReportHeader Object containing the header for the report. Obtained from the latest record found in the time period. ReportRows Collection of FinancialReportRow

30 30 (36) Structures FinancialReportHeader Address * Address The address of the client. Currency * String The currency used in the report ClientTypeId * Integer The client type id (21 = Invoice, 24 = Paymentplan) Administrator * String The administrator for the latest report in the report period. FromDate * DateTime The first date in the report period. ToDate * ToDate The last date in the report period. FinancialReportRow RowNumber * Address The row number RowId * String The type of row. See id table. Description * Integer Description of the row type Debit * String The total debit amount for all rows with this RowId in the time period. Credit * DateTime The total credit amount for all rows with this RowId in the time period. GetInvoiceReport This method retrieves an invoice report of all bought invoices for a given period of time. GetInvoiceReportRequest ClientId * Long Id that identifies a client in SveaWebPay FromDate * DateTime The start of the report period. ToDate * DateTime The end of the report period. GetInvoiceReportResponse ReportRows Collection of InvoiceReportRow

31 31 (36) InvoiceReportRow ReportDate * DateTime The report date of the invoice ClientId * Long The client id CustomerId * Long Customer id of the invoice InvoiceId * Long The invoice number Name * String Customer name Amount * Decimal The invoice amount AdministrationFee * Decimal CreditFee * Decimal GetAccountingReport This method retrieves an accounting report for a given period of time. GetAccountingReportRequest ClientId * Long Id that identifies a client in SveaWebPay FromDate * DateTime The start of the report period. ToDate * DateTime The end of the report period. GetAccountingReportResponse ReportRows Collection of AccountingReportRow AccountingReportRow ReportingDate * DateTime The report date of the accounting report AccountNumber * Long Id * Integer The type of account. Debit * Decimal The total debit amount on this account number during the time period. Credit * Decimal The total credit amount on this account number during the time period. Name * String The name of the account.

32 32 (36) GetRegressionReport This method retrieves a regression report for a given period of time. GetRegressionReportRequest ClientId * Long Id that identifies a client in SveaWebPay FromDate * DateTime The start of the report period. ToDate * DateTime The end of the report period. GetRegressionReportResponse ReportRows Collection of RegressionReportRow RegressionReportRow ClientId * Integer The client id TransactionType * Integer The numeric identifier for specified transaction PostingDate * DateTime The regression posting date CustomerId * Long Customer id InvoiceId * Long The invoice number RowNumber * Integer TransactionAmount * Decimal Sum of capital, rate and fee for payment plans. Name String Customer name RecordDate DateTime ReportingDate DateTime The report date of the regression User String Capital Decimal Only used for payment plan Rate Decimal Only used for payment plan Fee Decimal Only used for payment plan GetPaymentPlanReport This method retrieves a payment plan report for a given period of time. GetPaymentPlanReportRequest ClientId * Long Id that identifies a client in SveaWebPay FromDate * DateTime The start of the report period.

33 33 (36) ToDate * DateTime The end of the report period. GetPaymentPlanReportResponse ReportRows Collection of PaymentPlanReportRow PaymentPlanReportRow ReportingDate * DateTime The reporting date of the payment plan ClientId * Integer The client id CustomerId * Long Customer id of the invoice ContractId * Long The contract id Name * String Customer name Date DateTime Date for contract creation Amount Decimal Credit amount AdministrationFee Decimal Administration fee PayToClientAmount Decimal Amount paid to client OrderId String Order id GetInvoiceJournalReport GetInvoiceJournalReportRequest ClientId * Long Id that identifies a client in SveaWebPay FromDate * DateTime The start of the report period. ToDate * DateTime The end of the report period. GetInvoiceJournalReportResponse ReportRows Collection of InvoiceJournalReportRow InvoiceJournalReportRow ClientId * Long The client id CustomerId * Long Customer id of the invoice Name * String Customer name InvoiceId * Long The invoice number PostingDate * DateTime The invoice posting date InvoiceAmount * Decimal The invoice amount VatAmount * Decimal The VAT amount OrderNumber * String

34 34 (36) ReportDate * DateTime The report date of the invoice GetInvoicePdfLink This method returns an external link that can be used to retrieve an invoice PDF. GetInvoicePdfLinkRequest ClientId * Long Id that identifies a client in SveaWebPay InvoiceId * Long Id that identifies a invoice in SveaWebPay PdfLinkResponse PdfLink * String External link to an invoice. GetInvoicesWithChangedDueDate This method retrieves information about invoices with changed due date for specified client id. GetInvoicesWithChangedDueDateRequest ClientIds * List<Long> Ids that identifies a client in SveaWebPay FromDate * DateTime The start of the report period. ToDate * DateTime The end of the report period. GetInvoicesWithChangedDueDateResponse PdfLink * String External link to an invoice. InvoicesWithChangedDueDate InvoiceId * Long The invoice id number ClientId * Int Id that identifies a client in SveaWebPay OrgDueDate DateTime Original due date DueDate * DateTime Updated due date CreationDate * DateTime When the due date was changed

35 35 (36) ChangeInvoiceDueDate This method changes the due date for a previously created invoice. Please note that this function is not activated by default. You need to contact SveaWebPay support to activate this for your account. The allowed new DueDate is bound by the agreement between you and SveaWebPay. ChangeInvoiceDueDateRequest ClientId * Long Id that identifies a client in SveaWebPay InvoiceId * Long Invoice id for a specific invoice. NewDueDate * DateTime The new duedate for the invoice. ChangeInvoiceDueDateResponse Result Code Table Code Description 0 Accepted 1000 General error Authentication failed Client not specified Order is closed Order is denied Order is in state error Order has expired Order is missing Wrong order type Invalid amount Order over Svea limit Order over client limit Order rows missing Order rows do no not match invoice Order amount exceeds authorized amount Order type not supported Order is pending Invoice over authorized amount Invoice is missing Invoice could not be approved Credit invoice is missing Credit invoice has the wrong order id Credit invoice exceeds invoice amount Credit invoice on not approved invoice Invalid campaign code PDF contract template missing Partial delivery not allowed Unable to find a matching campaign

36 36 (36) Credit result rejected Customer is blocked (abuse) Client over credit limit Person does not exist Customer not found Unknown customer country Invalid customer data Invalid cocustomer data No addresses found Client not allowed Order type is required AddressSelector is not allowed CreatePaymentPlanDetails must be null CreatePaymentPlanDetails cannot be null Value must be set Client is not configured Invalid customer country code Invoice distribution type is required DeliverInvoiceDetails cannot be null InvoiceToCredit must be null InvoiceToCredit cannot be null OrderInformation is required CustomerIdentity is required Invalid value Invalid order type Order does not belong to this client Missing customer country code Invalid order date IndividualDetails is supplied with customer type company CompanyDetails is supplied with customer type individual IndividualDetails cannot be supplied when NationalIdNumber is used CompanyDetails cannot be suppled when NationalIdNumber is used Invalid AddressSelector AddressSelector is not allowed for this customer type Invalid zip code Unknown pending reason