Skip to main content

Adjust Invoice

The operation AdjustInvoice is used for adjusting the total invoice amount. The adjusted amount can be both negative and positive.

A negative adjustment amount cannot be greater than the amount of the invoice. To make several adjustments at the same time, several articles can be added.

Please Note

That positive adjustments may lead to additional credit checks of the customer.

Parameters#

Fieldmin OccursnillableMaxTypeDescription
Username1false50stringThe username used to authorize the request.
Password1false50stringThe password used to authorize the request.
CorrelationId1true50stringCorrelationID is sent back in the response.
CountryCode1false2stringThe country code (ISO 3166-1 alpha-2) for the country.
InvoiceNo1false50stringThe invoice number previously returned in AddInvoice.
InvoiceRows1false-InvoiceRow[]The articles that should be listed on the invoice and
contains the quantity and price of the article.
PurchaseClassification1true50stringThis field is used for an alternative credit evaluation. Contact Collector for more details.
SettlementReference1true50stringSettlement reference added to the return.
StoreId1true-intThe StoreId used for identification of store.

InvoiceRow#

ParameterRequiredTypeMaxDescription
ArticleIdxstring50The ArticleId of the product.
Descriptionxstring50The description of the product.
Quantityxint8The quantity of the product. 1-99999999 (0 not allowed)
QuantityUnit-string50The quantity unit of the product, e.g. pcs, meter, number, kg etc.
UnitPricexdecimal6,2Price per unit incl. VAT.
VATxdecimal6,2VAT in per cent

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:AdjustInvoice
Description:AdjustInvoice is used to update an 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>
</soapenv:Header>
<soapenv:Body>
<pay:AdjustInvoiceRequest>
<pay:CorrelationId>AdjustInvoiceV10</pay:CorrelationId>
<pay:CountryCode>SE</pay:CountryCode>
<pay:InvoiceNo>62366754</pay:InvoiceNo>
<pay:InvoiceRows>
<!--Zero or more repetitions:-->
<pay:InvoiceRow>
<pay:ArticleId>123456</pay:ArticleId>
<pay:Description>Article 123456</pay:Description>
<pay:Quantity>10</pay:Quantity>
<pay:QuantityUnit>pcs</pay:QuantityUnit>
<pay:UnitPrice>100</pay:UnitPrice>
<pay:VAT>25</pay:VAT>
</pay:InvoiceRow>
<pay:InvoiceRow>
<pay:ArticleId>123</pay:ArticleId>
<pay:Description>Discount on article 123456</pay:Description>
<pay:Quantity>1</pay:Quantity>
<pay:UnitPrice>-100</pay:UnitPrice>
<pay:VAT>25</pay:VAT>
</pay:InvoiceRow>
</pay:InvoiceRows>
<pay:PurchaseClassification xsi:nil="true"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<pay:SettlementReference xsi:nil="true"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<pay:StoreId>1234</pay:StoreId>
</pay:AdjustInvoiceRequest>
</soapenv:Body>
</soapenv:Envelope>

Error Codes#

Fault CodeDescription
AUTHORIZATION_FAILEDCould not authorize the request, check your login credentials. Please contact Collector for more help.
VALIDATION_COUNTRY_CODE_REQUIREDThe CountryCode field was not present in the request.
VALIDATION_ARTICLE_ID_REQUIREDAn article is missing its ArticleId.
VALIDATION_QUANTITY_RANGEThe Quantity field was not within its allowed range.
VALIDATION_SETTLEMENT_REFERENCE_LENGTHThe Settlement Reference field was not within its allowed range.
INVOICE_NOT_FOUNDThe invoice number does not exist.

If the error code you are looking for is not in the list above Please see separate page Error Codes