Update Credit Memo
Path parameters
idstringRequired
The ID of the credit memo to update.
Body
Represents a credit memo in the billing system.
$metaall of | nullableOptional
Platform entity metadata.
auditall ofOptional
Contains audit-related details for the entity.
idstringOptional
The unique identifier of the credit memo.
agreementall ofOptional
buyerall ofOptional
clientall ofOptional
erpDataall ofOptional
ERP-specific data related to the credit memo.
licenseeall ofOptional
priceall ofOptional
Pricing details of the credit memo.
productall ofOptional
sellerall ofOptional
statusall ofOptional
The current status of the credit memo.
string · enumOptionalPossible values:
vendorall ofOptional
Responses
200
OK
application/json
400
Bad Request
application/json
404
Not Found
application/json
500
Internal Server Error
put
PUT /public/v1/billing/credit-memos/{id} HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: application/json
Accept: */*
Content-Length: 4920
{
"$meta": {
"omitted": [
"text"
]
},
"audit": {
"created": {
"at": "2025-04-30T14:30:00.0000000+00:00",
"by": {
"id": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-04-30T14:30:00.0000000+00:00",
"by": {
"id": "text",
"name": "text",
"icon": "text"
}
},
"issued": {
"at": "2025-04-30T14:30:00.0000000+00:00",
"by": {
"id": "text",
"name": "text",
"icon": "text"
}
}
},
"id": "text",
"agreement": {
"id": "text",
"icon": "text",
"status": "New",
"name": "text"
},
"buyer": {
"id": "text",
"icon": "text",
"name": "text"
},
"client": {
"id": "text",
"icon": "text",
"type": "Client",
"status": "Active",
"name": "text"
},
"erpData": {
"addresses": {
"billTo": {
"name": "Microsoft Corporation",
"name2": "Latin America Collections",
"email": "[email protected]",
"customerNo": "AR-SCU-100064",
"addressLine1": "Cazadores de Coquimbo 2860",
"addressLine2": "Munro",
"addressLine3": "Cuyo 3367",
"city": "Carapachay",
"postCode": "75284-841",
"county": "Buenos Aires",
"country": "AR",
"contactName": "John Smith",
"contactNo": "AR-CON-100260",
"contactEmail": "[email protected]",
"contactPhone": "+541123456789",
"code": "CON-100333"
},
"licenseTo": {
"name": "Microsoft Corporation",
"name2": "Latin America Collections",
"email": "[email protected]",
"customerNo": "AR-SCU-100064",
"addressLine1": "Cazadores de Coquimbo 2860",
"addressLine2": "Munro",
"addressLine3": "Cuyo 3367",
"city": "Carapachay",
"postCode": "75284-841",
"county": "Buenos Aires",
"country": "AR",
"contactName": "John Smith",
"contactNo": "AR-CON-100260",
"contactEmail": "[email protected]",
"contactPhone": "+541123456789",
"code": "CON-100333"
},
"sellTo": {
"name": "Microsoft Corporation",
"name2": "Latin America Collections",
"email": "[email protected]",
"customerNo": "AR-SCU-100064",
"addressLine1": "Cazadores de Coquimbo 2860",
"addressLine2": "Munro",
"addressLine3": "Cuyo 3367",
"city": "Carapachay",
"postCode": "75284-841",
"county": "Buenos Aires",
"country": "AR",
"contactName": "John Smith",
"contactNo": "AR-CON-100260",
"contactEmail": "[email protected]",
"contactPhone": "+541123456789",
"code": "CON-100333"
},
"shipTo": {
"name": "Microsoft Corporation",
"name2": "Latin America Collections",
"email": "[email protected]",
"customerNo": "AR-SCU-100064",
"addressLine1": "Cazadores de Coquimbo 2860",
"addressLine2": "Munro",
"addressLine3": "Cuyo 3367",
"city": "Carapachay",
"postCode": "75284-841",
"county": "Buenos Aires",
"country": "AR",
"contactName": "John Smith",
"contactNo": "AR-CON-100260",
"contactEmail": "[email protected]",
"contactPhone": "+541123456789",
"code": "CON-100333"
}
},
"appliesToDocNo": "text",
"currencyCode": "text",
"documentDate": "2025-08-15T17:11:37.142Z",
"documentNo": "text",
"externalDocumentNo": "text",
"externalDocumentNo2": "text",
"insideSalesCode": "text",
"navisionCountryCode": "text",
"postingDate": "2025-08-15T17:11:37.142Z",
"rowVersion": 1,
"responsibilityCenterCode": "text",
"salesPersonCode": "text",
"shipmentMethodCode": "text",
"vatRegistrationNo": "text",
"yourReference": "text"
},
"licensee": {
"id": "text",
"icon": "text",
"name": "text",
"externalId": "text"
},
"lines": [
{
"id": "text",
"description": "text",
"description2": "text",
"documentNo": "text",
"erpData": {
"contractNo": "text",
"countryOfUsage": "text",
"dataOrigin": 1,
"externalPositionNo": "text",
"navisionCountryCode": "text",
"parentItemNo": "text",
"primary": {
"identifier": "text",
"value": "text",
"version": "text"
},
"secondary": {
"identifier": "text",
"value": "text",
"version": "text"
},
"rowVersion": 1,
"responsibilityCenterCode": "text",
"swoPurchaseOrderNo": "text",
"type": 1,
"unitOfMeasure": "text",
"varAgreementNo": "text",
"varPartnerNo": "text"
},
"itemNo": "text",
"lineNo": 1,
"period": {
"start": "2025-01-01T00:00:00.0000000+00:00",
"end": "2025-01-31T23:59:59.0000000+00:00"
},
"price": {
"amount": 1,
"amountIncludingVat": 1,
"discountAmount": 1,
"invoiceDiscountAmount": 1,
"lineAmount": 1,
"purchaseCurrencyCode": "text",
"purchaseCurrencyFactor": 1,
"purchasePrice": 1,
"purchasePriceLcy": 1,
"purchasePriceTotal": 1,
"purchasePriceTotalLcy": 1,
"quantity": 1,
"salesMarkup": 1,
"salesMargin": 1,
"unitPrice": 1,
"vatBaseAmount": 1,
"vatCalculationType": 1,
"vatPercent": 1
}
}
],
"price": {
"currency": "text",
"currencyFactor": 1,
"currencyFactor2": 1,
"margin": 1,
"markup": 1,
"totalPP": 1,
"totalSP": 1,
"totalST": 1,
"totalGT": 1
},
"product": {
"id": "text",
"name": "text",
"externalIds": {
"operations": "text"
},
"icon": "text",
"status": "text"
},
"seller": {
"id": "text",
"icon": "text",
"externalId": "text",
"name": "text",
"erpLink": {
"id": "text",
"audit": "[Circular Reference]",
"$meta": {
"omitted": [
"text"
]
},
"icon": "text",
"buyer": {
"id": "text",
"icon": "text",
"name": "text"
},
"seller": {
"0": "[",
"1": "C",
"2": "i",
"3": "r",
"4": "c",
"5": "u",
"6": "l",
"7": "a",
"8": "r",
"9": " ",
"10": "R",
"11": "e",
"12": "f",
"13": "e",
"14": "r",
"15": "e",
"16": "n",
"17": "c",
"18": "e",
"19": "]"
},
"name": "text",
"status": "Active",
"note": "text",
"externalIds": {
"erpCompanyContact": "text",
"erpCustomer": "text",
"accountExternalId": "text"
},
"address": {
"addressLine1": "text",
"addressLine2": "text",
"postCode": "text",
"city": "text",
"state": "text",
"country": "text"
}
}
},
"status": "Issued",
"vendor": {
"id": "text",
"icon": "text",
"type": "Client",
"status": "Active",
"name": "text"
}
}{
"$meta": {
"omitted": [
"text"
]
},
"audit": {
"created": {
"at": "2025-04-30T14:30:00.0000000+00:00",
"by": {
"id": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-04-30T14:30:00.0000000+00:00",
"by": {
"id": "text",
"name": "text",
"icon": "text"
}
},
"issued": {
"at": "2025-04-30T14:30:00.0000000+00:00",
"by": {
"id": "text",
"name": "text",
"icon": "text"
}
}
},
"id": "text",
"agreement": {
"id": "text",
"icon": "text",
"status": "New",
"name": "text"
},
"buyer": {
"id": "text",
"icon": "text",
"name": "text"
},
"client": {
"id": "text",
"icon": "text",
"type": "Client",
"status": "Active",
"name": "text"
},
"erpData": {
"addresses": {
"billTo": {
"name": "Microsoft Corporation",
"name2": "Latin America Collections",
"email": "[email protected]",
"customerNo": "AR-SCU-100064",
"addressLine1": "Cazadores de Coquimbo 2860",
"addressLine2": "Munro",
"addressLine3": "Cuyo 3367",
"city": "Carapachay",
"postCode": "75284-841",
"county": "Buenos Aires",
"country": "AR",
"contactName": "John Smith",
"contactNo": "AR-CON-100260",
"contactEmail": "[email protected]",
"contactPhone": "+541123456789",
"code": "CON-100333"
},
"licenseTo": {
"name": "Microsoft Corporation",
"name2": "Latin America Collections",
"email": "[email protected]",
"customerNo": "AR-SCU-100064",
"addressLine1": "Cazadores de Coquimbo 2860",
"addressLine2": "Munro",
"addressLine3": "Cuyo 3367",
"city": "Carapachay",
"postCode": "75284-841",
"county": "Buenos Aires",
"country": "AR",
"contactName": "John Smith",
"contactNo": "AR-CON-100260",
"contactEmail": "[email protected]",
"contactPhone": "+541123456789",
"code": "CON-100333"
},
"sellTo": {
"name": "Microsoft Corporation",
"name2": "Latin America Collections",
"email": "[email protected]",
"customerNo": "AR-SCU-100064",
"addressLine1": "Cazadores de Coquimbo 2860",
"addressLine2": "Munro",
"addressLine3": "Cuyo 3367",
"city": "Carapachay",
"postCode": "75284-841",
"county": "Buenos Aires",
"country": "AR",
"contactName": "John Smith",
"contactNo": "AR-CON-100260",
"contactEmail": "[email protected]",
"contactPhone": "+541123456789",
"code": "CON-100333"
},
"shipTo": {
"name": "Microsoft Corporation",
"name2": "Latin America Collections",
"email": "[email protected]",
"customerNo": "AR-SCU-100064",
"addressLine1": "Cazadores de Coquimbo 2860",
"addressLine2": "Munro",
"addressLine3": "Cuyo 3367",
"city": "Carapachay",
"postCode": "75284-841",
"county": "Buenos Aires",
"country": "AR",
"contactName": "John Smith",
"contactNo": "AR-CON-100260",
"contactEmail": "[email protected]",
"contactPhone": "+541123456789",
"code": "CON-100333"
}
},
"appliesToDocNo": "text",
"currencyCode": "text",
"documentDate": "2025-08-15T17:11:37.142Z",
"documentNo": "text",
"externalDocumentNo": "text",
"externalDocumentNo2": "text",
"insideSalesCode": "text",
"navisionCountryCode": "text",
"postingDate": "2025-08-15T17:11:37.142Z",
"rowVersion": 1,
"responsibilityCenterCode": "text",
"salesPersonCode": "text",
"shipmentMethodCode": "text",
"vatRegistrationNo": "text",
"yourReference": "text"
},
"licensee": {
"id": "text",
"icon": "text",
"name": "text",
"externalId": "text"
},
"lines": [
{
"id": "text",
"description": "text",
"description2": "text",
"documentNo": "text",
"erpData": {
"contractNo": "text",
"countryOfUsage": "text",
"dataOrigin": 1,
"externalPositionNo": "text",
"navisionCountryCode": "text",
"parentItemNo": "text",
"primary": {
"identifier": "text",
"value": "text",
"version": "text"
},
"secondary": {
"identifier": "text",
"value": "text",
"version": "text"
},
"rowVersion": 1,
"responsibilityCenterCode": "text",
"swoPurchaseOrderNo": "text",
"type": 1,
"unitOfMeasure": "text",
"varAgreementNo": "text",
"varPartnerNo": "text"
},
"itemNo": "text",
"lineNo": 1,
"period": {
"start": "2025-01-01T00:00:00.0000000+00:00",
"end": "2025-01-31T23:59:59.0000000+00:00"
},
"price": {
"amount": 1,
"amountIncludingVat": 1,
"discountAmount": 1,
"invoiceDiscountAmount": 1,
"lineAmount": 1,
"purchaseCurrencyCode": "text",
"purchaseCurrencyFactor": 1,
"purchasePrice": 1,
"purchasePriceLcy": 1,
"purchasePriceTotal": 1,
"purchasePriceTotalLcy": 1,
"quantity": 1,
"salesMarkup": 1,
"salesMargin": 1,
"unitPrice": 1,
"vatBaseAmount": 1,
"vatCalculationType": 1,
"vatPercent": 1
}
}
],
"price": {
"currency": "text",
"currencyFactor": 1,
"currencyFactor2": 1,
"margin": 1,
"markup": 1,
"totalPP": 1,
"totalSP": 1,
"totalST": 1,
"totalGT": 1
},
"product": {
"id": "text",
"name": "text",
"externalIds": {
"operations": "text"
},
"icon": "text",
"status": "text"
},
"seller": {
"id": "text",
"icon": "text",
"externalId": "text",
"name": "text",
"erpLink": {
"id": "text",
"audit": "[Circular Reference]",
"$meta": {
"omitted": [
"text"
]
},
"icon": "text",
"buyer": {
"id": "text",
"icon": "text",
"name": "text"
},
"seller": {
"0": "[",
"1": "C",
"2": "i",
"3": "r",
"4": "c",
"5": "u",
"6": "l",
"7": "a",
"8": "r",
"9": " ",
"10": "R",
"11": "e",
"12": "f",
"13": "e",
"14": "r",
"15": "e",
"16": "n",
"17": "c",
"18": "e",
"19": "]"
},
"name": "text",
"status": "Active",
"note": "text",
"externalIds": {
"erpCompanyContact": "text",
"erpCustomer": "text",
"accountExternalId": "text"
},
"address": {
"addressLine1": "text",
"addressLine2": "text",
"postCode": "text",
"city": "text",
"state": "text",
"country": "text"
}
}
},
"status": "Issued",
"vendor": {
"id": "text",
"icon": "text",
"type": "Client",
"status": "Active",
"name": "text"
}
}Last updated
Was this helpful?