The AddInvoice requests credit checks the customer, and if approved, adds the invoice. Otherwise an error message is returned.
Unless using the GetAddress method (only available in Sweden), this is the first step in creating an invoice.
After the invoice has been added, it needs to be activated. There's a few different ways to do this and you can find details of this under the Invoice administration menu.
This method will return the invoice number (InvoiceNo) which should be stored and used when handling the invoice in the future or for reference.
The functionality Campaign Products, included in the AddInvoice request, allows you to customize and set up campaigns for your customers with special conditions of sale, e.g. campaigns with longer payment time, different invoice fees or specific transaction costs. To use this functionality, an agreement with Collector must be made.
This method is available in the following countries:
|Username||false||50||string||The username used to authorize the request.|
|Password||false||50||string||The password used to authorize the request.|
|StoreId||true||4||short||The StoreId used for identification of store.|
|CorrelationId||true||50||string||CorrelationID is sent back in the response.|
|CountryCode||false||2||string||The country code (ISO 3166-1 alpha-2) for the country.|
|RegNo||false||12||string||Civic reg no of person in SE, NO, DK, FI.
In DE, AT, NL the date of birth should be provided.
DE, AT, NL: yyyymmdd
For companies, the organization number should be provided.
|ClientIpAddress||false||50||string||The IP address of the customer performing the purchase at the partner’s web shop.|
|Currency||false||3||string||Currency used during the purchase. Must be the same currency where the customer is registered and the e-store owner is located. Currency code is a three letter combination based on ISO 4217, for example: SEK, DKK, EUR.|
|CustomerNo||true||20||string||If the e-store wants to search for a customer by their own customer id, this field can be used to specify that number. Also shown on invoice.|
|OrderNo||true||20||string||The order's identification can be used to search for a specific order in the Collector Partner Portal.|
|OrderDate||false||-||datetime||The date that the costumer placed the order.|
|InvoiceRows||false||-||Invoice rows||The articles that should be listed on the invoice and contains the quantity and price of the article.|
Specify the type of invoice to use.
|InvoiceAddress||false||-||Address||The invoice address where the invoice should be sent to. For private persons this must be the address where the person is registered.|
|DeliveryAddress||false||-||Address||The address where the product should be delivered to. For private persons this must be the address where the person is registered.|
|CreditTime||true||-||int||Not used at the moment.
|ActivationOption||false||-||int||Different options for affecting a purchase.
Following values can be used (default value is 0):
0 = Purchase will be preliminary and must be activated, by using the ActivateInvoice, PartActivateInvoice or through the Collector Partner Portal.
1 = Auto activation, will automatically active the invoice so it can be sent out directly. This can only be used when the order can be delivered directly.
2 = Pre-Paid invoice. The purchase will be activated first when an invoice is paid. Not used at the moment.
|Reference||true||50||string||The Reference that should be as a reference on an invoice. Will only be used for companies.|
|CostCenter||true||64||string||For companies that needs to specify a cost center.|
|Gender||true||-||int||Persons gender according to the ISO/IEC 5218 standard.
0 = Not known
1 = Male
2 = Female
9 = Not applicable
This field is required in Germany, Netherlands and Austria.
The way to send the invoice. By default this is determined by Collector, but can be negotiated with Collector. If a current invoice exists, the latest information will be used next time the invoice is sent.
The value can be (default is 1):
|ProductCode||true||16||string||The campaign product code. The product code is determined by Collector. To use campaign products an agreement with Collector must be made.|
The type of the purchase, to specify where the purchase originates from.
The value can be:
|SalesPerson||true||50||string||Salesperson for order, if used.|
|AdditionalInformation||true||-||-||Used for specific handling, contact Collector for further information how to use this.|
|CorrelationId||true||50||string||CorrelationID from the request if any.|
|PaymentReference||true||50||string||The payment identification number. This is the id the customer must use when they do a payment of an invoice. Only returned if the invoice is auto activated.|
|AvailableReservationAmount||true||6,2||decimal||The current available reservation amount. If no credit reservation is done, 0 will be returned.|
|LowestAmountToPay||true||6,2||decimal||The lowest amount to pay on the invoice. Only returned if the invoice is auto activated.|
|TotalAmount||true||6,2||decimal||The total amount to pay for the invoice. Only returned if the invoice is auto activated.|
|InvoiceNo||false||-||string||The invoice number of the invoice.|
|InvoiceStatus||false||-||int||The status of the invoice.|
|DueDate||true||-||datetime||The due date of the invoice. Will only be returned when a purchase is directly activated.|
|InvoiceUrl||true||200||string||The url to invoice in pdf format.|