Skip to main content

Part Credit Invoice

Credits the included articles on the requested invoice. Can only be used on already activated invoices.

Parameters

Fieldmin OccursnillableMaxTypeDescription
Username1false50stringThe username used to authorize the request.
Password1false50stringThe password used to authorize the request.
ArticleList1false-Article[]The list of articles that should be credited. See below.
CorrelationId1true50stringCorrelationID is sent back in the response.
CountryCode1false2stringThe country code (ISO 3166-1 alpha-2) for the country.
CreditDate1false-datetimeThe date of the return.
InvoiceNo1false50stringThe invoice number previously returned in AddInvoice.
SettlementReference1true350stringSettlement reference added to the return.
StoreId1true4intThe StoreId used for identification of store.

Article

Parameter*RequiredTypeMaxDescription
ArticleIdstring50The ArticleId of the product.
Descriptionstring50The Description of the product. If included; needs to be identical with the description from the AddInvoice request.
Quantityxstring8The quantity of the product.
UnitPricedecimal6,2Price per unit incl. VAT.

*Please note that Quantity AND at least one of the parameters ArticleId, Description or UnitPrice must be specified.

Response

Fieldmin OccursnillableMaxTypeDescription
CorrelationId1true50stringCorrelationID from the request if any.

Example Requests

 Value
Environment:UAT
Service:PaymentService
URL:https://ecommercetest.collector.se/v3.0/PaymentServiceV10.svc?wsdl
Function:PartCreditInvoice
Description:The request credits the articles on the requested invoice
Notes:N/A
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:pay="http://schemas.ecommerce.collector.se/v30/PaymentService">
<soapenv:Header>
<pay:Username>USERNAME</pay:Username>
<pay:Password>PASSWORD</pay:Password>
<pay:ClientIpAddress>123.456.789</pay:ClientIpAddress>
</soapenv:Header>
<soapenv:Body>
<pay:PartCreditInvoiceRequest>
<pay:ArticleList>
<pay:Article>
<pay:ArticleId>82493</pay:ArticleId>
<pay:Quantity>11</pay:Quantity>
<pay:UnitPrice>50</pay:UnitPrice>
</pay:Article>
</pay:ArticleList>
<pay:CountryCode>SE</pay:CountryCode>
<pay:CreditDate>2020-04-20</pay:CreditDate>
<pay:InvoiceNo>62396756</pay:InvoiceNo>
<pay:SettlementReference>111</pay:SettlementReference>
<pay:StoreId>1234</pay:StoreId>
</pay:PartCreditInvoiceRequest>
</soapenv:Body>
</soapenv:Envelope>

Error Codes

Please see separate page Error Codes

Fault CodeDescription
UNIQUE_ARTICLE_NOT_FOUNDWhen article with the same article id is found several times but have different unit prices. The unit price must be specified also to locate the specific article.
INVALID_QUANTITYThe quantity of an article is too low or too high compared to the quantity or quantity left on the article.