---
id: partactivateinvoice
title: Part Activate Invoice
hide_title: true
description: "Activating parts of an invoice"
---

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import Flag from '../../../../src/components/flag/flag';
import Ingress from '../../../../src/components/ingress/ingress.react';

<Ingress title="Part Activate Invoice">
This functionality is used when part delivering goods.
</Ingress>

Creates an active invoice for the requested articles. If any pending articles remain a new pending invoice will be created for those articles and returned in NewInvoiceNo
(this NewInvoiceNo should be used when activating the invoice in the next shipment).

## 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[]](#article)         | The list of articles that should be activated. See below.                                                                          |
| CorrelationId | 1          | false    | 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.                                                                             |
| InvoiceNumber | 1          | false    | 50  | string                        | The invoice number previously returned in AddInvoice.                                                                              |
| PaymentInfo   | 1          | false    | -   | [PaymentInfo[]](#paymentinfo) | Bank or invoice Information for payout. Used in this request to replace the PaymentInfo sent in the AddInvoice request, if needed. |
| StoreId       | 1          | false    | -   | 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 |
| 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.

#### PaymentInfo

| Parameter         | Required | Type   | Max | Description                                                                                       |
| :---------------- | :------- | :----- | :-- | :------------------------------------------------------------------------------------------------ |
| ReceiverName      |          | string | 64  | Name of the company                                                                               |
| ReceiverRegNumber |          | string | 64  | The organization number of receiving company                                                      |
| PaymentReference  |          | string | 350 | Reference added to the payment. OCR number must be no longer than 20 characters                   |
| BankAccount       |          | string | 50  | Bank account number. For bank account types with multiple parts "&#124;" (pipe) is used as a delimiter. |
| BankAccountType   |          | int    |     |                                                                                                   |

#### BankAccountType

- 0 - Bic Iban (DEUTDEFF DE99203205004989123456)
- 1 - Iban (DE99203205004989123456)
- 2 - Plusgiro, with OCR
- 3 - Plusgiro, with message
- 4 - Bankgiro, with OCR
- 5 - Bankgiro, with message

## Response

| Field             | min Occurs | nillable | Max | Type     | Description                                                             |
| ----------------- | ---------- | -------- | --- | -------- | ----------------------------------------------------------------------- |
| CorrelationId     | 1          | true     | 50  | string   | CorrelationID from the request if any.                                  |
| DueDate           | 1          | false    | 12  | datetime | The due date of the invoice.                                            |
| InvoiceUrl        | 1          | true     | -   |          | The url to invoice in pdf format.                                       |
| LowestAmountToPay | 1          | false    | 6,2 | decimal  | The lowest amount to pay on the invoice.                                |
| NewInvoiceNumber  | 1          | true     | 50  | string   | The new invoice number with the articles that where not yet delivered.  |
| PaymentReference  | 1          | true     | 50  | string   | The Reference that should be as a reference on an invoice.              |
| TotalAmount       | 1          | false    | 6,2 | decimal  | The total amount to pay for the invoice.                                |

### Example Requests

| &nbsp;       | Value                                                                                                                                       |
| ------------ | :------------------------------------------------------------------------------------------------------------------------------------------ |
| Environment: | UAT                                                                                                                                         |
| Service:     | PaymentService                                                                                                                              |
| URL:         | https://ecommercetest.collector.se/v3.0/PaymentServiceV10.svc?wsdl                                                                          |
| Function:    | PartActivateInvoice                                                                                                                         |
| Description: | The operation acitvates parts of an pending invoice. For Direct invoice it returns invoice details for other invoice types only invoice no. |
| Notes:       | N/A                                                                                                                                         |

<Tabs defaultValue="reqB2C" values={[
{ label: 'B2C Request', value: 'reqB2C', },
{ label: 'B2C Response', value: 'resB2C', }]}>
<TabItem value="reqB2C">

```xml

<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:PartActivateInvoiceRequest>
         <pay:ArticleList>
            <pay:Article>
               <pay:ArticleId>ArticleId 1</pay:ArticleId>
               <pay:Description>Description 1</pay:Description>
               <pay:Quantity>1</pay:Quantity>
               <pay:UnitPrice>100</pay:UnitPrice>
            </pay:Article>
         </pay:ArticleList>
         <pay:CorrelationId>PartActivateInvoiceV10</pay:CorrelationId>
         <pay:CountryCode>SE</pay:CountryCode>
         <pay:InvoiceNo>62366759</pay:InvoiceNo>
         <pay:StoreId>1234</pay:StoreId>
      </pay:PartActivateInvoiceRequest>
   </soapenv:Body>
</soapenv:Envelope>
```

</TabItem>
<TabItem value="resB2C">

```xml
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PartActivateInvoiceResponse xmlns="http://schemas.ecommerce.collector.se/v30/PaymentService">
         <CorrelationId>PartActivateInvoiceV10</CorrelationId>
         <DueDate>2020-05-31T23:59:59</DueDate>
         <InvoiceUrl>https://minasidor-internaltest.collector.se/invoice?id=xGyujJtJ8OrrSJw8Im9_CFMQp_DC3SVg_tm5pvmObJ-8D7XSdrLca_3Enh4ZU5WRo2kk6TRSzW0hkpa-6nO7dliJ1YrAV0oAKkYQ8iPDrO2yRols_6AL7q5fDF9Bw0zQ&amp;language=sv-SE</InvoiceUrl>
         <LowestAmountToPay>110.00</LowestAmountToPay>
         <NewInvoiceNo>62366760</NewInvoiceNo>
         <PaymentReference>100002387702959</PaymentReference>
         <TotalAmount>110.00</TotalAmount>
      </PartActivateInvoiceResponse>
   </s:Body>
</s:Envelope>
```

</TabItem>
</Tabs>

### Error Codes

Please see separate page [Error Codes](/docs/paymentsApi/integration/error-codes)

| Fault Code               | Description                              |
| :----------------------- | :--------------------------------------- |
| INVOICE_NOT_FOUND        | The invoice number does not exist. |
| 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. |
