Customer Credit Note

URL: https://api.finance.visma.net/v1/CustomerCreditNote

For information about the ERP logic behind Customer Credit Note, please refer to the ERP Manual Help: Sales invoices of type Credit note

Methods

All Customer Credit Notes

URL: https://api.finance.visma.net/v1/CustomerCreditNote

Query Parameters

• financialPeriod=YYYYMM

Lets you define what financialPeriod to include in the response

• status=string

Limits response to CreditNotes with a status

• expandAttachments=boolean

Lets you decide if you want attachments to be expanded or not.

• expandTaxDetails=boolean

Lets you decide if you want tax detail lines to be expanded or not.

Usage Example

This will return Customer CreditNotes in the financial period 01-2020 that have the status “balanced”, and will not expand attachments or tax detail lines.

GET https://api.finance.visma.net/v1/customerCreditNote?financialPeriod=202001&status=balanced&expandAttachments=false&expandTaxDetails=false

POST CustomerCreditNote

URL: https://api.finance.visma.net/v1/CustomerCreditNote

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

JSON Request body

{
    "currencyId": {
        "value": "NOK"
    },
    "externalReference": {
        "value": "ExRef"
    },
    "lines": [
        {
            "operation": "Insert",
            "inventoryNumber": {
                "value": "A"
            },
            "quantity": {
                "value": 1
            },
            "unitPriceInCurrency": {
                "value": 1
            }
        }
    ],
    "customerNumber": {
        "value": "10000"
    },
    "referenceNumber": {
        "value": "25698"
    },
    "documentDate": {
        "value": "2025-11-21"
    },
    "postPeriod": {
        "value": "112025"
    },
    "financialPeriod": {
        "value": "202511"
    }
}

If sent successfully, the API will return:

PUT CustomerCreditNote

URL: https://api.finance.visma.net/v1/CustomerCreditNote/{creditNoteNumber}

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

URL: PUT https://api.finance.visma.net/v1/CustomerCreditNote/25698

JSON Request body

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

If sent successfully, the API will return: