Credit Memo
The Credit object refers to a credit memo created within the ERP system.
id
string
A unique identifier for the credit memo.
Example: CRD-3295-7900-0234
agreement
A reference to the agreement object.
Example:
{
"id": "AGR-2119-4550-8674-5962",
"href": "/commerce/agreements/ACC-1234-1234",
"name": "Microsoft Office 365 for My Company"
}buyer
A reference to the buyer object.
Example:
{
"id": "BUY-3731-7971",
"href": "/accounts/buyers/BUY-3731-7971",
"name": "Adam Ruszczak",
"icon": "/static/BUY-3731-7971/icon.png"
}client
A reference to the client account object.
Example:
{
"id": "ACC-1234-4444",
"href": "/accounts/accounts/ACC-1234-4444",
"name": "Best LLC",
"icon": "/static/ACC-1234-4444/account.png"
}erpData
Represents the credit memo fields from the ERP system.
Example:
"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"
}licensee
A reference to the licensee object.
Example:
{
"id": "LCE-9625-9634",
"href": "/accounts/licensees/LCE-9625-9634",
"name": "John Smith",
"icon": "/static/LCE-9625-9634/icon.png"
} lines
The list of credit memo lines associated with the credit memo.
Example:
[
{
"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
}
}
]price
The credit memo price summary with aggregated price values for all credit memo lines. Note that not all fields are visible to all actors.
Example:
{
"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
}product
A reference to the product object.
Example:
{
"id": "PRD-1111-1111-1111",
"name": "Microsoft Office 365 NCE",
"icon": "/static/PRD-1111-1111-1111/logo.png"
}seller
A reference to the seller object.
Example:
{
"id": "SEL-9121-8944",
"href": "/accounts/sellers/SEL-9121-8944",
"name": "Software LN",
"icon": "/static/SEL-9121-8944/icon.png"
}status
enum
The status of the credit memo.
Example: Issued
audit
The audit object with possible entries: Created or Updated.
Example:
{
"created": { "at": "...", "by": { } },
"updated": { "at": "...", "by": { } }
}CreditMemoErpData
addresses
erpAddressList
The list of addresses associated with the invoice.
Example:
{
"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": "[email protected] ",
"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": "[email protected] "
}
}appliesToDocNo
string
Applies to document number.
Example: 460201
currencyCode
string
Represents the currency code.
Example: USD
documentDate
DateTimeOffset
Represents the document date.
Example: 2025-07-25T00:00:00.000Z
documentNo
string
Represents the document number.
Example: SG-CM-108834
externalDocumentNo
string
Represents the external document number. Example: EXDONO_6786089946345
externalDocumentNo2
string
Represents the external document number 2. Example: EXDONO2_919764016716
insideSalesCode
string
Represents the inside sales code.
Example: DOMAIN\JAN.SAGER
navisionCountryCode
string
Represents the country code in our ERP system. Example: SG
postingDate
DateTimeOffset
Represents the posting date.
Example: 2025-01-15T16:45:24.123Z
responsibilityCenterCode
string
Represents the code of the responsibility centre.
Example: BUENOSAIRE.
rowVersion
string
Represents the version of the row.
Example: 1645619029.
salesPersonCode
string
Represents the code for the sales person. Example: BR-FPA.
shipmentMethodCode
string
Represents the code of the shipment method.
Example: EMAIL.
vatRegistrationNo
string
Represents the VAT registration number. Example: 30-53619620-6.
yourReference
string
Custom reference (free text) or the statement ID (fixed format).
Example: YourRef_180588433545113841284876514643996099936880.
CreditMemoPriceSummary
currency
string
Represents the currency code.
Example: USD
currencyFactor
decimal
Represents the currency factor.
Example: 0.7829320806
currencyFactor2
decimal
Represents the currency factor 2.
Example: 0.7829320806
margin
decimal
Represents the margin.
Example: 33.3333333333
markup
decimal
Represents the markup.
Example: 50.0000000000
totalGT
decimal
Represents the total gross amount.
Example: 32.70000
totalPP
decimal
Represents the total purchase price.
Example: 20.00000
totalSP
decimal
Represents the total sales price.
Example: 30.00000
totalST
decimal
Represents the total sales tax.
Example: 2.70000
Last updated
Was this helpful?