List Checks

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

Loading API schema for Check…

GET/api/v1/checks

bash

curl -X GET "https://api.nx-us.net/api/v1/checks" \
  -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",
      "payee": {},
      "address": {},
      "isPending": "false",
      "isQueuedForPrint": "true",
      "isTaxIncluded": "true",
      "salesTaxCode": {},
      "transactionNumber": "123",
      "amount": "900.00",
      "account": {
        "ListId": "40000-933270541",
        "FullName": "Accounts Receivable"
      },
      "amountInHomeCurrency": "1125.00",
      "externalId": "E09C86CF-9D6E-4EF2-BCBE-4D66B6B0F754",
      "linkedTransactions": [
        {
          "objectType": null,
          "transactionId": null,
          "transactionType": null,
          "transactionDate": null,
          "refNumber": null,
          "linkType": null,
          "amount": null
        }
      ],
      "expenseLines": [
        {
          "id": null,
          "objectType": null,
          "account": null,
          "amount": null,
          "memo": null,
          "class": null,
          "payee": null,
          "salesRepresentative": null,
          "salesTaxCode": null,
          "taxAmount": null,
          "billableStatus": null,
          "customFields": null
        }
      ],
      "itemLines": [
        {
          "id": null,
          "objectType": null,
          "otherCustomField1": null,
          "otherCustomField2": null,
          "item": null,
          "description": null,
          "quantity": null,
          "cost": null,
          "amount": null,
          "customer": null,
          "class": null,
          "overrideItemAccount": null,
          "billableStatus": null,
          "itemGroup": null,
          "unitOfMeasure": null,
          "rate": null,
          "salesTaxCode": null,
          "inventorySite": null,
          "inventorySiteLocation": null,
          "serialNumber": null,
          "lotNumber": null,
          "serviceDate": null,
          "customFields": null
        }
      ],
      "itemGroupLines": [
        {
          "id": null,
          "objectType": null,
          "itemGroup": null,
          "description": null,
          "quantity": null,
          "totalAmount": null,
          "unitOfMeasure": null,
          "isPrintItemsInGroup": null,
          "lines": null,
          "customFields": 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>"
}