CreditMemos

get/public/v1/billing/credit-memos/{id}

Request

  • Base URL: https://api.platform.softwareone.com
  • URL: https://api.platform.softwareone.com/public/v1/billing/credit-memos/{id}
  • Auth: none declared

Path parameters

idstring required

Query parameters

selectstring

Response

OK

revisioninteger
idstring

The unique identifier of the credit memo.

countryCodestring

The country code.

documentNostring

The document number assigned by the ERP system.

status'Issued'
appliesToDocNostring nullable

The 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.

cloudiqInvoiceReferencestring nullable

Cloud iQ invoice reference.

cloudiqReportLayoutinteger nullable

Cloud iQ report layout.

Example response

{
  "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"
      }
    }
  },
  "externalIds": {
    "statement": "SOM-6707-9575-2243-2374",
    "customer": "BUY-1366-0012",
    "agreement": "AGR-0027-6450-2635"
  },
  "statement": {
    "id": "SOM-1234-1234-1234-1234-1234"
  },
  "invoice": {
    "id": "INV-123-456-789"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.