Create Order
CreateOrder
This method creates an invoice or payment plan order in the system.
Input
CreateOrderRequest
| Field | R | Type | Description |
|---|---|---|---|
| ClientId | - | Long | ID that identifies a client in Svea Payments system. Required if the account has several clients of this order type. |
| OrderInformation | * | CreateOrderInformation | Information needed to create the order. |
Output
CreateOrderResponse
| Field | R | Type | Description |
|---|---|---|---|
| CreateOrderResult | - | CreateOrderResult | The result of the operation. |
| OrderRows | - | Collection of NumberedOrderRow | The order rows in the request, decorated with an order row number. |
Structures
CreateOrderInformation
| Field | R | Type | Description |
|---|---|---|---|
| ClientOrderNumber | - | String(32) | Order number from the client’s ordersystem. |
| OrderRows | * | Collection of OrderRows | The order rows connected to the order. |
| CustomerIdentity | * | CustomerIdentity | The ID details of the customer. |
| OrderDate | * | DateTime | Date of the order. |
| AddressSelector | - | String | Used to select a specific address returned from GetAddress. |
| CustomerReference | - | String(32) | (Optional) Customer reference. |
| OrderType | * | OrderType | Invoice or PaymentPlan. |
| OrderDeliveryAddress | - | Address | Order delivery address, if different from the address provided in CustomerIdentity. |
| CreatePaymentPlanDetails | - | CreatePaymentPlanDetails | Required if order type is PaymentPlan. |
Address
| Field | R | Type | Description |
|---|---|---|---|
| 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
| Field | R | Type | Description |
|---|---|---|---|
| CampaignCode | - | Long | What campaign code to use. Either a campaign code or a fixed monthly amount must be entered. |
| CoCustomerIdentity | - | CustomerIdentity | Additional customer details if applicable. |
| SendAutomaticGiroPaymentForm | - | Bool | Indicates if the AutoGiro payment form should be sent to the customer. |
| FixedMonthlyAmount | - | Decimal(18,2) | The desired amount to pay each month, including the notification fee. |
CreateOrderResult
| Field | R | Type | Description |
|---|---|---|---|
| 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. |
| PendingReasons | - | List<string> | Contains identifiers if the order is pending. |