List Credit Memos

Returns a paginated list of CreditMemos where the default and maximum limits are both 150.

Loading API schema for CreditMemo…

GET/api/v1/credit-memos

bash

curl -X GET "https://api.nx-us.net/api/v1/credit-memos" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "X-Connection-Id: YOUR_CONNECTION_ID" \
  -H "Accept: application/json"

Response200

json

{
  "requestId": "<string>",
  "success": "<boolean>",
  "data": [
    {
      "id": "<string>",
      "objectType": "<string>",
      "createdAt": "<date-time>",
      "updatedAt": "<date-time>",
      "revisionNumber": "<string>",
      "transactionDate": "2024-10-01",
      "currency": {
        "ListId": "170000-1071506140",
        "FullName": "USD"
      },
      "exchangeRate": "1.25",
      "refNumber": "121345",
      "memo": "Refund for overpayment",
      "transactionNumber": "123",
      "customer": {},
      "class": {},
      "receivablesAccount": {},
      "template": {},
      "billingAddress": {},
      "billingAddressBlock": {},
      "shippingAddress": {},
      "shippingAddressBlock": {},
      "isPending": "false",
      "poNumber": "PO-2024-0142",
      "terms": {},
      "dueDate": "2026-07-01",
      "salesRepresentative": {},
      "fob": "Origin",
      "shipDate": "2023-10-25",
      "shipMethod": {},
      "subtotal": "1000.00",
      "itemSalesTax": {},
      "salesTaxPercentage": "0.07",
      "salesTaxTotal": "10.00",
      "totalAmount": "1000.00",
      "creditRemaining": "25.11",
      "creditRemainingInHomeCurrency": "<number>",
      "customerMessage": {},
      "isToBePrinted": "true",
      "isToBeEmailed": "true",
      "isTaxIncluded": "true",
      "customerSalesTaxCode": {},
      "other": "Custom value",
      "lines": [],
      "lineGroups": [],
      "amount": "900.00",
      "entity": {
        "ListId": "920000-1071506140",
        "FullName": "Barley, Renee"
      },
      "account": {
        "ListId": "40000-933270541",
        "FullName": "Accounts Receivable"
      },
      "externalId": "E09C86CF-9D6E-4EF2-BCBE-4D66B6B0F754",
      "linkedTransactions": [
        {
          "objectType": null,
          "transactionId": null,
          "transactionType": null,
          "transactionDate": null,
          "refNumber": null,
          "linkType": null,
          "amount": null
        }
      ],
      "customFields": [
        {
          "ownerId": null,
          "name": null,
          "type": null,
          "value": null
        }
      ]
    }
  ],
  "count": "<integer>",
  "limit": "<integer>",
  "totalCount": "<integer>",
  "timestamp": "<date-time>",
  "nextCursor": "<string>",
  "hasMore": "<boolean>",
  "remainingCount": "<integer>"
}