Create credit memo

Creates new credit memos.

post

Bulk async operation. Requires MPT-Upsert and MPT-Async headers. Returns 202 Accepted with MPT-Task-Id header for tracking the async operation.

Query parameters

Responses

201

Created

application/json

Represents a credit memo in the billing system.

revisioninteger · int32Optional

idstringOptional

The unique identifier of the credit memo.

countryCodestringOptional

The country code.

Example: IE

documentNostringOptional

The document number assigned by the ERP system.

Example: DOC-67890

statusstring · enumOptionalPossible values:

cloudiqInvoiceReferencestring · nullableOptional

Cloud iQ invoice reference.

cloudiqReportLayoutinteger · int32 · nullableOptional

Cloud iQ report layout.

400

Bad Request

application/json

403

Forbidden

application/json

500

Internal Server Error

post/public/v1/billing/credit-memos

HTTPcURLJavaScriptPython

POST /public/v1/billing/credit-memos HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*

{
  "audit": {
    "created": {
      "at": "2026-07-22T11:02:12.523Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "updated": {
      "at": "2026-07-22T11:02:12.523Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "issued": {
      "at": "2026-07-22T11:02:12.523Z",
      "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": "[e-mail]",
        "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": "[e-mail]",
        "contactPhone": "[phone]",
        "code": "CON-100333"
      },
      "licenseTo": {
        "name": "Microsoft Corporation",
        "name2": "Latin America Collections",
        "email": "[e-mail]",
        "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": "[e-mail]",
        "contactPhone": "[phone]",
        "code": "CON-100333"
      },
      "sellTo": {
        "name": "Microsoft Corporation",
        "name2": "Latin America Collections",
        "email": "[e-mail]",
        "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": "[e-mail]",
        "contactPhone": "[phone]",
        "code": "CON-100333"
      },
      "shipTo": {
        "name": "Microsoft Corporation",
        "name2": "Latin America Collections",
        "email": "[e-mail]",
        "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": "[e-mail]",
        "contactPhone": "[phone]",
        "code": "CON-100333"
      }
    },
    "appliesToDocNo": "text",
    "currencyCode": "text",
    "documentDate": "2026-07-22T11:02:12.523Z",
    "documentNo": "text",
    "externalDocumentNo": "text",
    "externalDocumentNo2": "text",
    "insideSalesCode": "text",
    "navisionCountryCode": "text",
    "postingDate": "2026-07-22T11:02:12.523Z",
    "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": "2025-01-01T00:00:00+00:00",
        "end": "2025-01-31T23:59:59+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
      },
      "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"
  },
  "cloudiqInvoiceReference": "text",
  "cloudiqReportLayout": 1
}