Customer Debit Note

<page>
<metadata>
<title>Customer Debit Note</title>
<path>/vismanetapi/setting-up-your-integration/how-tos/customerledgerendpoint/customerdebitnote</path>
<kind>section</kind>
<description>Common usage example for Customer Debit Note (ScreenId=AR301000)</description>
<lastmod>2025-11-28T09:30:17+01:00</lastmod>
</metadata>
<content>
# Customer Debit Note

Common usage example for Customer Debit Note (ScreenId=AR301000)


URL: `https://api.finance.visma.net/v1/CustomerDebittNote`

For information about the ERP logic behind Customer Debit Note, please refer to the [ERP Manual Help: Sales invoices of type Debit note](https://help.content.visma.net/Sweden/SE_EN/online-help/o2c/ar301000-ref.html)

## Methods

---

### All Customer Debit Notes

URL: `https://api.finance.visma.net/v1/CustomerDebitNote`

#### Query Parameters

- Project=String
  
Will limit response to documents with the specified project

#### Usage Example

This will return Customer Debit Notes with projectID 20.

**GET** `https://api.finance.visma.net/v1/customerDebitNote?project=20`

---

### POST CustomerDebitNote

URL: `https://api.finance.visma.net/v1/CustomerDebitNote`

This example shows the minimum fields you should send to be able to post a new Customer Debit Note, if you are using automatic numbering you can omit the “referenceNumber” field.

#### JSON Request body

```json
{
    "lines": [
        {
            "operation": "Insert",
            "description": {
                "value": "Test"
            },
            "quantity": {
                "value": 2
            },
            "unitPriceInCurrency": {
                "value": 2
            },
            "uom": {
                "value": "STK"
            }
        }
    ],
    "customerNumber": {
        "value": "10000"
    },
    "referenceNumber": {
        "value": "000050"
    },
    "documentDate": {
        "value": "2025-01-16"
    },
    "postPeriod": {
        "value": "012025"
    },
    "financialPeriod": {
        "value": "202501"
    },
    "invoiceText": {
        "value": "DebitNote"
    }
}
```

If sent successfully, the API will return:

![Created](201created4.png)

---

### PUT CustomerDebitNote

URL: `https://api.finance.visma.net/v1/CustomerDebitNote/{debitNoteNumber}`

When using PUT, you only send the fields you want to update. In the below example, we update the first line of the Debit Note:

URL:
PUT `https://api.finance.visma.net/v1/CustomerDebitNote/000050`

#### JSON Request body

```json
{
    "lines": [
        {
            "operation": "Insert",
            "lineNumber": {
                "value": 1
            },
            "inventoryNumber": {
                "value": "6"
            },
            "quantity": {
                "value": 1
            },
            "unitPriceInCurrency": {
                "value": 1
            }
        }
    ]
}
```

If sent successfully, the API will return:

![No Content](nocontent3.png)</content>
</page>