# Credit Memo

The Credit object refers to a credit memo created within the ERP system.

<table><thead><tr><th width="113">Field</th><th width="204">Type</th><th>Description</th></tr></thead><tbody><tr><td>id</td><td><code>string</code></td><td><p>A unique identifier for the credit memo. </p><p>Example: CRD-3295-7900-0234</p></td></tr><tr><td>agreement</td><td><a href="../commerce-api/agreements"><code>agreement</code></a></td><td><p>A reference to the agreement object.</p><p>Example:</p><pre class="language-json" data-overflow="wrap" data-full-width="true"><code class="lang-json">{
  "id": "AGR-2119-4550-8674-5962",
  "href": "/commerce/agreements/ACC-1234-1234",
  "name": "Microsoft Office 365 for My Company"
}
</code></pre></td></tr><tr><td>buyer</td><td><a href="../accounts-api/buyer"><code>buyer</code></a></td><td><p>A reference to the buyer object. </p><p>Example:</p><pre class="language-json" data-overflow="wrap" data-full-width="true"><code class="lang-json">{
  "id": "BUY-3731-7971",
  "href": "/accounts/buyers/BUY-3731-7971",
  "name": "Adam Ruszczak",
  "icon": "/static/BUY-3731-7971/icon.png"
}
</code></pre></td></tr><tr><td>client</td><td><a href="../accounts-api/account"><code>account</code></a></td><td><p>A reference to the client account object. </p><p>Example:</p><pre class="language-json" data-overflow="wrap" data-full-width="true"><code class="lang-json">{
  "id": "ACC-1234-4444",
  "href": "/accounts/accounts/ACC-1234-4444",
  "name": "Best LLC",
  "icon": "/static/ACC-1234-4444/account.png"
}
</code></pre></td></tr><tr><td>erpData</td><td><a href="#creditmemoerpdata"><code>CreditMemoErpData</code></a></td><td><p>Represents the credit memo fields from the ERP system. </p><p>Example:</p><pre class="language-json" data-overflow="wrap" data-full-width="true"><code class="lang-json">"erpData": {
    "addresses": {
        "billTo": {
            "name": "Siemens Canada Limited",
            "customerNo": "CA-SCU-100008",
            "addressLine1": "1550 Appleby Line",
            "city": "Burlington",
            "postCode": "L7L 6X7",
            "county": "ON",
            "country": "CND",
            "contactNo": "CA-CON-100040"
        },
        "licenseTo": {
            "name": "Siemens Canada Limited",
            "customerNo": "CA-SCU-100008",
            "addressLine1": "1550 Appleby Line",
            "city": "Burlington",
            "postCode": "L7L 6X7",
            "county": "ON",
            "country": "CND",
            "contactName": "Andrew Luther",
            "contactNo": "CA-CON-100047"
        },
        "sellTo": {
            "name": "Siemens Canada Limited",
            "customerNo": "CA-SCU-100008",
            "addressLine1": "1550 Appleby Line",
            "city": "Burlington",
            "postCode": "L7L 6X7",
            "county": "ON",
            "country": "CND",
            "contactNo": "CA-CON-100040"
        },
        "shipTo": {
            "name": "Siemens Canada Limited",
            "addressLine1": "1550 Appleby Line",
            "city": "Burlington",
            "postCode": "L7L 6X7",
            "county": "ON",
            "country": "CND"
        }
    },
    "appliesToDocNo": "460201",
    "currencyCode": "USD",
    "documentDate": "2025-07-25T00:00:00.000Z",
    "documentNo": "SG-CM-108834",
    "externalDocumentNo": "EXDONO_6786089946345",
    "externalDocumentNo2": "EXDONO2_919764016716",
    "navisionCountryCode": "SG",
    "postingDate": "2025-07-25T00:00:00.000Z",
    "rowVersion": 1645619029,
    "yourReference": "YourRef_180588433545113841284876514643996099936880"
}
</code></pre></td></tr><tr><td>licensee</td><td><a href="../accounts-api/licensee"><code>licensee</code></a></td><td><p>A reference to the licensee object.</p><p>Example:</p><pre class="language-json" data-overflow="wrap" data-full-width="true"><code class="lang-json">{
  "id": "LCE-9625-9634",
  "href": "/accounts/licensees/LCE-9625-9634",
  "name": "John Smith",
  "icon": "/static/LCE-9625-9634/icon.png"
} 
</code></pre></td></tr><tr><td>lines</td><td><a href="credit-memo/credit-memo-line"><code>creditMemoLine[]</code></a></td><td><p>The list of credit memo lines associated with the credit memo.</p><p>Example:</p><pre class="language-json" data-overflow="wrap" data-full-width="true"><code class="lang-json">[
  {
    "id": "CRL-8003-9067-8612-0011",
    "description": "TeamViewer Corporate",
    "description2": "Subscription for 1 Year",
    "documentNo": "SG-CM-108852",
    "erpData": {
      "countryOfUsage": "CA",
      "dataOrigin": 0,
      "navisionCountryCode": "SG",
      "primary": {
        "identifier": ""
      },
      "secondary": {
        "identifier": ""
      },
      "rowVersion": 1646155471,
      "responsibilityCenterCode": "HN",
      "type": 2,
      "unitOfMeasure": "Pieces"
    },
    "itemNo": "TV02.00852.ML",
    "lineNo": 130000,
    "period": {
      "start": "1753-01-01T00:00:00.000Z",
      "end": "1753-01-01T00:00:00.000Z"
    },
    "price": {
      "amount": 15.0,
      "amountIncludingVat": 16.35,
      "discountAmount": 0.0,
      "invoiceDiscountAmount": 0.0,
      "lineAmount": 15.0,
      "purchaseCurrencyCode": "SGD",
      "purchaseCurrencyFactor": 0.0,
      "purchasePrice": 10.0,
      "purchasePriceLcy": 10.0,
      "purchasePriceTotal": 10.0,
      "purchasePriceTotalLcy": 10.0,
      "quantity": 1,
      "salesMarkup": 94.81,
      "salesMargin": 48.65,
      "unitPrice": 15.0,
      "vatBaseAmount": 15.0,
      "vatCalculationType": 0,
      "vatPercent": 9.0
    }
  }
]
</code></pre></td></tr><tr><td>price</td><td><a href="#creditmemopricesummary"><code>creditMemoPriceSummary</code></a></td><td><p>The credit memo price summary with aggregated price values for all credit memo lines. Note that not all fields are visible to all actors.</p><p>Example:</p><pre class="language-json" data-overflow="wrap" data-full-width="true"><code class="lang-json">{
    "currency": "USD",
    "currencyFactor": 0.7829320806,
    "currencyFactor2": 0.7829320806,
    "margin": 33.3333333333,
    "markup": 50.0000000000,
    "totalPP": 20.00000,
    "totalSP": 30.00000,
    "totalST": 2.70000,
    "totalGT": 32.70000
}
</code></pre></td></tr><tr><td>product</td><td><a href="../catalog-api/product"><code>product</code></a></td><td><p>A reference to the product object.</p><p>Example:</p><pre class="language-json" data-overflow="wrap" data-full-width="true"><code class="lang-json">{
    "id": "PRD-1111-1111-1111",
    "name": "Microsoft Office 365 NCE",
    "icon": "/static/PRD-1111-1111-1111/logo.png"
}
</code></pre></td></tr><tr><td>seller</td><td><a href="../accounts-api/seller"><code>seller</code></a></td><td><p>A reference to the seller object.</p><p>Example:</p><pre class="language-json" data-overflow="wrap" data-full-width="true"><code class="lang-json">{
  "id": "SEL-9121-8944",
  "href": "/accounts/sellers/SEL-9121-8944",
  "name": "Software LN",
  "icon": "/static/SEL-9121-8944/icon.png"
}
</code></pre></td></tr><tr><td>status</td><td><code>enum</code></td><td><p>The status of the credit memo. </p><p>Example: Issued</p></td></tr><tr><td>vendor</td><td><a href="../accounts-api/account"><code>account</code></a></td><td>A  reference to vendor account object.</td></tr><tr><td>audit</td><td><a href="../common-api-objects/audit"><code>audit</code></a></td><td><p>The audit object with possible entries: <code>Created</code> or <code>Updated</code>.</p><p>Example:</p><pre class="language-json" data-overflow="wrap" data-full-width="true"><code class="lang-json">{
  "created": { "at": "...", "by": { } },
  "updated": { "at": "...", "by": { } }
}
</code></pre></td></tr></tbody></table>

## CreditMemoErpData <a href="#creditmemoerpdata" id="creditmemoerpdata"></a>

<table><thead><tr><th width="213">Field</th><th width="165">Type</th><th width="381">Description</th></tr></thead><tbody><tr><td>addresses</td><td><code>erpAddressList</code></td><td><p>The list of addresses associated with the invoice.</p><p>Example:</p><pre class="language-json" data-overflow="wrap" data-full-width="true"><code class="lang-json">{
  "billTo": {
      "name": "Siemens Schweiz AG",
      "name2": "Kreditorenbuchhaltung",
      "customerNo": "CHC-SCU-100495",
      "addressLine1": "Freilagerstrasse 40 ",
      "city": "Zürich",
      "postCode": "8047",
      "country": "CH",
      "contactNo": "CHC-CON-101975"
  },
  "licenseTo": {
      "name": "Raiffeisen Schweiz Genossenschaft",
      "customerNo": "CH-SCU-102355",
      "addressLine1": "Raiffeisenplatz 4",
      "city": "St. Gallen",
      "postCode": "9001",
      "county": "SG",
      "country": "CH",
      "contactName": "Siemens license holder",
      "contactNo": "CH-CON-250378",
      "contactEmail": "support-snc.ch@siemens.com ",
      "contactPhone": "+41 71 225 87 70"
  },
  "sellTo": {
      "name": "Siemens Schweiz AG",
      "customerNo": "CHC-SCU-100493",
      "addressLine1": "Industriestrasse 22 CH",
      "city": "Volketswil",
      "postCode": "8604",
      "country": "CH",
      "contactNo": "CHC-CON-101971"
  },
  "shipTo": {
      "name": "Siemens Schweiz AG",
      "addressLine1": "Industriestrasse 22",
      "city": "Volketswil",
      "postCode": "8604",
      "country": "CH",
      "contactEmail": "support-snc.ch@siemens.com "
  }
}
</code></pre></td></tr><tr><td>appliesToDocNo</td><td><code>string</code></td><td><p>Applies to document number.</p><p>Example: 460201</p></td></tr><tr><td>currencyCode</td><td><code>string</code></td><td><p>Represents the currency code.</p><p>Example: USD</p></td></tr><tr><td>documentDate</td><td><code>DateTimeOffset</code></td><td><p>Represents the document date.</p><p>Example: 2025-07-25T00:00:00.000Z</p></td></tr><tr><td>documentNo</td><td><code>string</code></td><td><p>Represents the document number. </p><p>Example: SG-CM-108834</p></td></tr><tr><td>externalDocumentNo</td><td><code>string</code></td><td>Represents the external document number. Example: EXDONO_6786089946345</td></tr><tr><td>externalDocumentNo2</td><td><code>string</code></td><td>Represents the external document number 2. Example: EXDONO2_919764016716</td></tr><tr><td>insideSalesCode</td><td><code>string</code></td><td><p>Represents the inside sales code. </p><p>Example: DOMAIN\JAN.SAGER</p></td></tr><tr><td>navisionCountryCode</td><td><code>string</code></td><td>Represents the country code in our ERP system. Example: SG</td></tr><tr><td>postingDate</td><td><code>DateTimeOffset</code></td><td><p>Represents the posting date. </p><p>Example: 2025-01-15T16:45:24.123Z</p></td></tr><tr><td>responsibilityCenterCode</td><td><code>string</code></td><td><p>Represents the code of the responsibility centre.</p><p>Example: BUENOSAIRE.</p></td></tr><tr><td>rowVersion</td><td><code>string</code></td><td><p>Represents the version of the row. </p><p>Example: 1645619029.</p></td></tr><tr><td>salesPersonCode</td><td><code>string</code></td><td>Represents the code for the sales person. Example: BR-FPA.</td></tr><tr><td>shipmentMethodCode</td><td><code>string</code></td><td><p>Represents the code of the shipment method.</p><p>Example: EMAIL.</p></td></tr><tr><td>vatRegistrationNo</td><td><code>string</code></td><td>Represents the VAT registration number. Example: 30-53619620-6.</td></tr><tr><td>yourReference</td><td><code>string</code></td><td><p>Custom reference (free text) or the statement ID (fixed format).</p><p>Example: YourRef_180588433545113841284876514643996099936880.</p></td></tr></tbody></table>

## CreditMemoPriceSummary

<table><thead><tr><th width="162">Field</th><th width="182">Type</th><th>Description</th></tr></thead><tbody><tr><td>currency</td><td><code>string</code></td><td><p>Represents the currency code. </p><p>Example: <code>USD</code></p></td></tr><tr><td>currencyFactor</td><td><code>decimal</code></td><td><p>Represents the currency factor. </p><p>Example: <code>0.7829320806</code></p></td></tr><tr><td>currencyFactor2</td><td><code>decimal</code></td><td><p>Represents the currency factor 2. </p><p>Example: <code>0.7829320806</code></p></td></tr><tr><td>margin</td><td><code>decimal</code></td><td><p>Represents the  margin. </p><p>Example: <code>33.3333333333</code></p></td></tr><tr><td>markup</td><td><code>decimal</code></td><td><p>Represents the  markup.</p><p>Example: <code>50.0000000000</code></p></td></tr><tr><td>totalGT</td><td><code>decimal</code></td><td><p>Represents the total gross amount. </p><p>Example: <code>32.70000</code></p></td></tr><tr><td>totalPP</td><td><code>decimal</code></td><td><p>Represents the total purchase price. </p><p>Example: <code>20.00000</code></p></td></tr><tr><td>totalSP</td><td><code>decimal</code></td><td><p>Represents the total sales price. </p><p>Example: <code>30.00000</code></p></td></tr><tr><td>totalST</td><td><code>decimal</code></td><td><p>Represents the total sales tax. </p><p>Example: <code>2.70000</code></p></td></tr></tbody></table>
