Bulk async operation. Requires MPT-Upsert and MPT-Async headers. Returns 202 Accepted with MPT-Task-Id header for tracking the async operation.
Created
Represents a credit memo in the billing system.
The unique identifier of the credit memo.
The country code.
IEThe document number assigned by the ERP system.
DOC-67890The date when the invoice was posted.
2025-05-01T10:00:00+00:00The date when the document was created.
2025-04-30T10:00:00+00:00The external document number associated with the invoice.
OC 4500355450The second external document number associated with the invoice.
4540599242Can be the custom reference (free text) or the statement ID (fixed format).
Custom reference: US-PSI-1525628 RITM55345369 Wrong SCU; Statement ID: SOMM-8224-9785-1293-2113The primary name associated with the address.
Microsoft CorporationThe secondary name associated with the address.
Latin America CollectionsThe email associated with the address.
no-reply@company.comThe customer number associated with the address.
AR-SCU-100064The first line of the address.
Cazadores de Coquimbo 2860The second line of the address.
MunroThe third line of the address.
Cuyo 3367The city of the address.
CarapachayThe postal code of the address.
75284-841The county/state/region of the address.
Buenos AiresThe country of the address.
ARThe contact name associated with the address.
John SmithThe contact number associated with the address.
AR-CON-100260The contact email associated with the address.
john.smith@company.comThe contact phone number associated with the address.
+541123456789The code associated with the address.
CON-100333The primary name associated with the address.
Microsoft CorporationThe secondary name associated with the address.
Latin America CollectionsThe email associated with the address.
no-reply@company.comThe customer number associated with the address.
AR-SCU-100064The first line of the address.
Cazadores de Coquimbo 2860The second line of the address.
MunroThe third line of the address.
Cuyo 3367The city of the address.
CarapachayThe postal code of the address.
75284-841The county/state/region of the address.
Buenos AiresThe country of the address.
ARThe contact name associated with the address.
John SmithThe contact number associated with the address.
AR-CON-100260The contact email associated with the address.
john.smith@company.comThe contact phone number associated with the address.
+541123456789The code associated with the address.
CON-100333The primary name associated with the address.
Microsoft CorporationThe secondary name associated with the address.
Latin America CollectionsThe email associated with the address.
no-reply@company.comThe customer number associated with the address.
AR-SCU-100064The first line of the address.
Cazadores de Coquimbo 2860The second line of the address.
MunroThe third line of the address.
Cuyo 3367The city of the address.
CarapachayThe postal code of the address.
75284-841The county/state/region of the address.
Buenos AiresThe country of the address.
ARThe contact name associated with the address.
John SmithThe contact number associated with the address.
AR-CON-100260The contact email associated with the address.
john.smith@company.comThe contact phone number associated with the address.
+541123456789The code associated with the address.
CON-100333The primary name associated with the address.
Microsoft CorporationThe secondary name associated with the address.
Latin America CollectionsThe email associated with the address.
no-reply@company.comThe customer number associated with the address.
AR-SCU-100064The first line of the address.
Cazadores de Coquimbo 2860The second line of the address.
MunroThe third line of the address.
Cuyo 3367The city of the address.
CarapachayThe postal code of the address.
75284-841The county/state/region of the address.
Buenos AiresThe country of the address.
ARThe contact name associated with the address.
John SmithThe contact number associated with the address.
AR-CON-100260The contact email associated with the address.
john.smith@company.comThe contact phone number associated with the address.
+541123456789The code associated with the address.
CON-100333The document number to which this credit memo applies.
The currency code of the credit memo.
The document date of the credit memo.
The document number of the credit memo.
The external document number of the credit memo.
The second external document number of the credit memo.
The inside sales code associated with the credit memo.
The Navision country code of the credit memo.
The posting date of the credit memo.
The revision of the invoice, used for versioning control.
The row version of the credit memo, used for concurrency control.
The responsibility center code of the credit memo.
The sales person code of the credit memo.
The shipment method code of the credit memo.
The VAT registration number of the credit memo.
The reference provided by the customer.
Statement identifier.
SOM-6707-9575-2243-2374Bill to customer identifier.
BUY-1366-0012Agreement identifier.
AGR-0027-6450-2635The unique identifier for the credit memo line.
The description of the credit memo line.
The secondary description (aka additional info) of the credit memo line.
The document number associated with the credit memo line.
The contract number associated with the credit memo line.
The country of usage for the credit memo line.
The data origin for the credit memo line.
The external position number for the credit memo line.
The Navision country code for the credit memo line.
The parent item number for the credit memo line.
The unique identifier for the ERP code.
The value of the ERP code.
The version of the ERP code.
The unique identifier for the ERP code.
The value of the ERP code.
The version of the ERP code.
The row version of the credit memo line, for concurrency control.
The responsibility center code for the credit memo line.
The SWO purchase order number for the credit memo line.
The type of the credit memo line.
The unit of measure for the credit memo line.
The VAR agreement number for the credit memo line.
The VAR partner number for the credit memo line.
The item number for the credit memo line.
The line number for the credit memo line.
The amount for the credit memo line, visible to clients or operations.
The amount including VAT for the credit memo line, visible to clients or operations.
The discount amount for the credit memo line, visible to clients or operations.
The invoice discount amount for the credit memo line, visible to clients or operations.
The line amount for the credit memo line, visible to clients or operations.
The currency used for the purchase price, visible only to operations.
The factor applied to the purchase currency, visible only to operations.
The purchase price for the credit memo line, visible only to operations.
The purchase price in local currency for the credit memo line, visible only to operations.
The total purchase price for the credit memo line, visible only to operations.
The total purchase price in local currency for the credit memo line, visible only to operations.
The quantity for the credit memo line.
The sales markup for the credit memo line, visible only to operations.
The sales margin for the credit memo line, visible only to operations.
The unit price for the credit memo line.
The VAT base amount for the credit memo line.
The VAT calculation type for the credit memo line.
The VAT percentage for the credit memo line.
Cloud iQ tenant.
The currency of the credit memo.
The factor applied to the currency, used for conversion or adjustments.
The second factor applied to the currency, used for conversion or adjustments.
The margin value of the credit memo, visible to operations.
The markup value of the credit memo, visible to operations.
The total purchase price (PP) of the credit memo, visible to operations.
The total selling price (SP) of the credit memo, visible to clients or operations.
The total sales tax (ST) of the credit memo, visible to clients or operations.
The total gross amount (GT) of the credit memo, visible to clients or operations.
The unique identifier of the statement.
SOM-1234-1234-1234-1234-1234Specifies the status of an analytics operation.
The unique identifier of the invoice.
INV-123-456-789The ERP applies-to document number this credit memo was raised against. Computed by the store from the ErpData JSON and never written directly, so it always agrees with the value inside that JSON. Deliberately exposed as filterable and sortable, which the JSON copy is not, so that a credit memo can be found by the invoice it was raised against. The invoice-side link lookup seeks on the same index.
Cloud iQ invoice reference.
Cloud iQ report layout.
Bad Request
Forbidden
Internal Server Error
No content
POST /public/v1/billing/credit-memos HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
{
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"issued": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"revision": 1,
"id": "text",
"countryCode": "IE",
"documentNo": "DOC-67890",
"attributes": {
"postingDate": "2025-05-01T10:00:00+00:00",
"documentDate": "2025-04-30T10:00:00+00:00",
"externalDocumentNo": "OC 4500355450",
"externalDocumentNo2": "4540599242",
"yourReference": "Custom reference: US-PSI-1525628 RITM55345369 Wrong SCU; Statement ID: SOMM-8224-9785-1293-2113"
},
"erpData": {
"addresses": {
"billTo": {
"name": "Microsoft Corporation",
"name2": "Latin America Collections",
"email": "no-reply@company.com",
"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": "john.smith@company.com",
"contactPhone": "+541123456789",
"code": "CON-100333"
},
"licenseTo": {
"name": "Microsoft Corporation",
"name2": "Latin America Collections",
"email": "no-reply@company.com",
"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": "john.smith@company.com",
"contactPhone": "+541123456789",
"code": "CON-100333"
},
"sellTo": {
"name": "Microsoft Corporation",
"name2": "Latin America Collections",
"email": "no-reply@company.com",
"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": "john.smith@company.com",
"contactPhone": "+541123456789",
"code": "CON-100333"
},
"shipTo": {
"name": "Microsoft Corporation",
"name2": "Latin America Collections",
"email": "no-reply@company.com",
"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": "john.smith@company.com",
"contactPhone": "+541123456789",
"code": "CON-100333"
}
},
"appliesToDocNo": "text",
"currencyCode": "text",
"documentDate": "2026-01-01T00:00:00.000Z",
"documentNo": "text",
"externalDocumentNo": "text",
"externalDocumentNo2": "text",
"insideSalesCode": "text",
"navisionCountryCode": "text",
"postingDate": "2026-01-01T00:00:00.000Z",
"revision": 1,
"rowVersion": 1,
"responsibilityCenterCode": "text",
"salesPersonCode": "text",
"shipmentMethodCode": "text",
"vatRegistrationNo": "text",
"yourReference": "text"
},
"externalIds": {
"statement": "SOM-6707-9575-2243-2374",
"customer": "BUY-1366-0012",
"agreement": "AGR-0027-6450-2635"
},
"agreement": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"status": "New"
},
"buyer": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
},
"client": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"type": "Client",
"status": "Active"
},
"licensee": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"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": "2026-01-01T00:00:00.000Z",
"end": "2026-01-01T00:00:00.000Z"
},
"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
},
"cloudiqTenant": "text"
}
],
"price": {
"currency": "text",
"currencyFactor": 1,
"currencyFactor2": 1,
"margin": 1,
"markup": 1,
"totalPP": 1,
"totalSP": 1,
"totalST": 1,
"totalGT": 1
},
"product": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"externalIds": {
"operations": "text",
"defaultErpItem": "text"
},
"status": "text"
},
"seller": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"externalId": "text"
},
"status": "Issued",
"vendor": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"type": "Client",
"status": "Active"
},
"statement": {
"revision": 1,
"id": "SOM-1234-1234-1234-1234-1234"
},
"analytics": {
"status": "Pending"
},
"invoice": {
"revision": 1,
"id": "INV-123-456-789"
},
"appliesToDocNo": "text",
"cloudiqInvoiceReference": "text",
"cloudiqReportLayout": 1
}