Parameter dictionary

This section describes the parameters, values and data types in the requests.

InvoiceStatus:

Value Name Description
0 On hold The invoice is temporarily blocked, and Collector needs to look into it. The invoice can not be activated when it have this status.
1 Pending The invoice is pending and can be activated by Merchant (usually within 14 days).
2 Activated The invoice is activated by Merchant. Collector has purchased the invoice.
5 Rejected The invoice was rejected by Collector, which means that the customer and invoice was not approved, you need to offer another payment option to customer.
6 Signing The invoice needs to be digitally signed by end customer before the invoice can be activated.

 

Address:

Parameter Req. Type Max. Description
Firstname false string 50 Must be excluded for B2B purchases
Lastname false string 50 Must be excluded for B2B purchases 
CompanyName true string 50  
Address1 true string 50  
Address2 false string 50  
COAddress false string 50  
PostalCode true string 50  
City true string 50  
PhoneNumber false string 20 Should always contain countrycode (eg. +46 xxx xxx xxx). 
CellPhoneNumber false string 20 Should always contain countrycode (eg. +46 xxx xxx xxx).
Email false string 260  
CountryCode true string 2  

 

InvoiceRow:

Parameter Req. Type Max. Description
ArticleId true string 50 The ArticleId of the product.
Description true string 50 The description of the product.
Quantity true int 8 The quantity of the product.
UnitPrice true decimal 6,2 Price per unit incl. VAT.
VAT true decimal 2,2 VAT in percent.

 

ArticleList:

Parameter Req. Type Max. Description
ArticleId true string 50 The ArticleId of the product.
Description true string 50 The description of the product.
Quantity true int 8 The quantity of the product.

 

Accounts:

Parameter Req. Type Max. Description
InvoiceBalance false decimal 6,2 The current balance of the invoice.
InvoiceStatus false string - The current status of the invoice. Possible values are:
  • OnHold
  • Approved
  • Rejected
  • Canceled
  • Expired
  • Activated
  • Closed
  • Moved
  • DebtCollection
InvoiceType false string - The invoice type. Possible values are:
  • Direct Invoice Account
  • Invoice Account
  • Credit Account
LatestInvoiceNo true string 50 The invoice number of the invoice.
MovedToPaymentRef true string - If the invoice has been moved to another account, this is the new accounts payment reference. If the invoice has not been moved, this returns null.
NotificationStopped false string - Returns true if the current invoice is stopped for notifications. Returns false if it is not stopped.
PaymentReference true string 50 The invoices payment reference.

 

Transaction:

Parameter Req. Type Max. Description
TransactionType false string   The type of the transaction.
TransactionDate false string   The date the transaction was made.
ArticleId true string   The article id used in the transaction. Null if the transaction doesn’t have an article.
Description true string   A description of the transaction.
UnitPrice false decimal   The unit amount used the transaction. This can be the price of an article in a purchase transaction or the amount of a fee in a fee transaction.
Currency false string   The currency used in the transaction. Currency code is a three letter combination based on ISO 4217, for example SEK, DKK, EUR. 
Quantity false int   The number of items in the transaction.
VatRate true decimal   The VAT rate used in this transaction.
MovedToAccount true string   If the transaction has been moved to another account this will contain the Payment Reference number for that account.
MovedFromAccount true string   If the transaction has been moved from another account this will contain the Payment Reference number for that account.