List Credit Memos

Returns a paginated list of CreditMemos where the default limit is 150.

Loading API schema for CreditMemo…

GET/api/v1/credit-memos

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

{
  "requestId": "<string>",
  "success": "<boolean>",
  "data": [
    {
      "id": "<string>",
      "objectType": "<string>",
      "createdAt": "<date-time>",
      "updatedAt": "<date-time>",
      "revisionNumber": "<string>",
      "transactionDate": "<date>",
      "currency": {
        "id": "<string>",
        "fullname": "<string>"
      },
      "exchangeRate": "<number>",
      "refNumber": "<string>",
      "memo": "<string>",
      "transactionNumber": "<integer>",
      "customer": {
        "id": "<string>",
        "fullname": "<string>"
      },
      "class": {
        "id": "<string>",
        "fullname": "<string>"
      },
      "receivablesAccount": {
        "id": "<string>",
        "fullname": "<string>"
      },
      "template": {
        "id": "<string>",
        "fullname": "<string>"
      },
      "billingAddress": {
        "line1": "<string>",
        "line2": "<string>",
        "line3": "<string>",
        "line4": "<string>",
        "line5": "<string>",
        "city": "<string>",
        "state": "<string>",
        "postalCode": "<string>",
        "country": "<string>",
        "note": "<string>"
      },
      "billingAddressBlock": {
        "line1": "<string>",
        "line2": "<string>",
        "line3": "<string>",
        "line4": "<string>",
        "line5": "<string>"
      },
      "shippingAddress": {
        "line1": "<string>",
        "line2": "<string>",
        "line3": "<string>",
        "line4": "<string>",
        "line5": "<string>",
        "city": "<string>",
        "state": "<string>",
        "postalCode": "<string>",
        "country": "<string>",
        "note": "<string>"
      },
      "shippingAddressBlock": {
        "line1": "<string>",
        "line2": "<string>",
        "line3": "<string>",
        "line4": "<string>",
        "line5": "<string>"
      },
      "isPending": "<boolean>",
      "poNumber": "<string>",
      "terms": {
        "id": "<string>",
        "fullname": "<string>"
      },
      "dueDate": "<date>",
      "salesRepresentative": {
        "id": "<string>",
        "fullname": "<string>"
      },
      "fob": "<string>",
      "shipDate": "<date>",
      "shipMethod": {
        "id": "<string>",
        "fullname": "<string>"
      },
      "subtotal": "<number>",
      "itemSalesTax": {
        "id": "<string>",
        "fullname": "<string>"
      },
      "salesTaxPercentage": "<number>",
      "salesTaxTotal": "<number>",
      "totalAmount": "<number>",
      "creditRemaining": "<number>",
      "creditRemainingInHomeCurrency": "<number>",
      "customerMsg": {
        "id": "<string>",
        "fullname": "<string>"
      },
      "isToBePrinted": "<boolean>",
      "isToBeEmailed": "<boolean>",
      "isTaxIncluded": "<boolean>",
      "customerSalesTaxCode": {
        "id": "<string>",
        "fullname": "<string>"
      },
      "other": "<string>",
      "lines": [
        {
          "objectType": null,
          "id": null,
          "item": null,
          "description": null,
          "quantity": null,
          "unitOfMeasure": null,
          "overrideUnitOfMeasureSet": null,
          "rate": null,
          "ratePercent": null,
          "class": null,
          "amount": null,
          "inventorySite": null,
          "inventorySiteLocation": null,
          "serialNumber": null,
          "lotNumber": null,
          "expirationDate": null,
          "serviceDate": null,
          "salesTaxCode": null,
          "otherCustomField1": null,
          "otherCustomField2": null,
          "creditCardTransaction": null,
          "customFields": null
        }
      ],
      "lineGroups": [
        {
          "id": null,
          "objectType": null,
          "itemGroup": null,
          "description": null,
          "quantity": null,
          "unitOfMeasure": null,
          "overrideUnitOfMeasureSet": null,
          "shouldPrintItemsInGroup": null,
          "totalAmount": null,
          "lines": null,
          "customFields": null
        }
      ],
      "amount": "<number>",
      "entity": {
        "id": "<string>",
        "fullname": "<string>"
      },
      "account": {
        "id": "<string>",
        "fullname": "<string>"
      },
      "hasValidLineItems": "<boolean>",
      "externalId": "<string>",
      "linkedTransactions": [
        {
          "objectType": "<string>",
          "transactionId": "<string>",
          "transactionType": "<string>",
          "transactionDate": "<date>",
          "refNumber": "<string>",
          "linkType": "<string>",
          "amount": "<number>"
        }
      ],
      "expenseLines": [
        {
          "id": "<string>",
          "objectType": "<string>",
          "account": null,
          "amount": "<number>",
          "memo": "<string>",
          "class": null,
          "customer": null,
          "salesRepresentative": null,
          "salesTaxCode": null,
          "taxAmount": "<number>",
          "vendor": null,
          "billableStatus": null,
          "customFields": null
        }
      ],
      "itemLines": [
        {
          "id": "<string>",
          "objectType": "<string>",
          "otherCustomField1": "<string>",
          "otherCustomField2": "<string>",
          "item": null,
          "description": "<string>",
          "quantity": "<number>",
          "cost": "<number>",
          "amount": "<number>",
          "customer": null,
          "class": null,
          "overrideItemAccount": null,
          "billableStatus": null,
          "itemGroup": null,
          "unitOfMeasure": "<string>",
          "rate": "<number>",
          "salesTaxCode": null,
          "inventorySite": null,
          "inventorySiteLocation": null,
          "serialNumber": "<string>",
          "lotNumber": "<string>",
          "serviceDate": "<date>",
          "customFields": null
        }
      ],
      "itemGroupLines": [
        {
          "id": "<string>",
          "objectType": "<string>",
          "itemGroup": null,
          "description": "<string>",
          "quantity": "<number>",
          "totalAmount": "<number>",
          "unitOfMeasure": "<string>",
          "isPrintItemsInGroup": "<boolean>",
          "lines": null,
          "customFields": null
        }
      ],
      "customFields": [
        {
          "ownerId": "<string>",
          "name": "<string>",
          "type": "<string>",
          "value": "<string>"
        }
      ]
    }
  ],
  "nextCursor": "<string>",
  "page": "<integer>",
  "count": "<integer>",
  "limit": "<integer>",
  "totalCount": "<integer>",
  "pageCount": "<integer>",
  "hasMore": "<boolean>",
  "timestamp": "<date-time>",
  "remainingCount": "<integer>"
}