Part Credit Invoice
Credits the included articles on the requested invoice. Can only be used on already activated invoices.
Parameters​
Field | min Occurs | nillable | Max | Type | Description |
---|---|---|---|---|---|
Username | 1 | false | 50 | string | The username used to authorize the request. |
Password | 1 | false | 50 | string | The password used to authorize the request. |
ArticleList | 1 | false | - | Article[] | The list of articles that should be credited. See below. |
CorrelationId | 1 | true | 50 | string | CorrelationID is sent back in the response. |
CountryCode | 1 | false | 2 | string | The country code (ISO 3166-1 alpha-2) for the country. |
CreditDate | 1 | false | - | datetime | The date of the return. |
InvoiceNo | 1 | false | 50 | string | The invoice number previously returned in AddInvoice. |
SettlementReference | 1 | true | 350 | string | Settlement reference added to the return. |
StoreId | 1 | true | 4 | int | The StoreId used for identification of store. |
Article​
Parameter* | Required | Type | Max | Description |
---|---|---|---|---|
ArticleId | string | 50 | The ArticleId of the product. | |
Description | string | 50 | The Description of the product. If included; needs to be identical with the description from the AddInvoice request. | |
Quantity | x | string | 8 | The quantity of the product. |
UnitPrice | decimal | 6,2 | Price per unit incl. VAT. |
*Please note that Quantity AND at least one of the parameters ArticleId, Description or UnitPrice must be specified.
Response​
Field | min Occurs | nillable | Max | Type | Description |
---|---|---|---|---|---|
CorrelationId | 1 | true | 50 | string | CorrelationID 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 |
- B2C Request
- B2C Response
<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>
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
<PartCreditInvoiceResponse xmlns="http://schemas.ecommerce.collector.se/v30/PaymentService">
<CorrelationId i:nil="true" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"/>
</PartCreditInvoiceResponse>
</s:Body>
</s:Envelope>
Error Codes​
Please see separate page Error Codes
Fault Code | Description |
---|---|
UNIQUE_ARTICLE_NOT_FOUND | When 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_QUANTITY | The quantity of an article is too low or too high compared to the quantity or quantity left on the article. |