List Invoices

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

Loading API schema for Invoice…

GET/api/v1/invoices

bash

curl -X GET "https://api.nx-us.net/api/v1/invoices" \
  -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",
      "customer": {},
      "class": {},
      "receivablesAccount": {},
      "template": {},
      "dueDate": "<date>",
      "billingAddress": {},
      "shippingAddress": {},
      "isPending": "false",
      "isFinanceCharge": "true",
      "purchaseOrderNumber": "PO-2024-0142",
      "terms": {},
      "salesRepresentative": {},
      "shipmentOrigin": "Origin",
      "shippingDate": "2023-10-25",
      "shippingMethod": {},
      "itemSalesTax": {},
      "customerMessage": {},
      "isQueuedForPrint": "true",
      "isQueuedForEmail": "true",
      "isTaxIncluded": "true",
      "customerSalesTaxCode": {},
      "otherCustomField": "Custom value",
      "subtotal": "<number>",
      "salesTaxTotal": "<number>",
      "balanceRemaining": "<number>",
      "isPaid": "<boolean>",
      "transactionNumber": "1042",
      "billingAddressBlock": {},
      "shippingAddressBlock": {},
      "salesTaxPercentage": "7.5%",
      "appliedAmount": "-250.00",
      "balanceRemainingInHomeCurrency": "1125.00",
      "suggestedDiscountAmount": "25.00",
      "suggestedDiscountDate": "2023-11-10",
      "amount": "900.00",
      "account": {},
      "amountInHomeCurrency": "1125.00",
      "externalId": "E09C86CF-9D6E-4EF2-BCBE-4D66B6B0F754",
      "linkedTransactions": [
        {
          "objectType": null,
          "transactionId": null,
          "transactionType": null,
          "transactionDate": null,
          "refNumber": null,
          "linkType": null,
          "amount": null
        }
      ],
      "lines": [],
      "lineGroups": [],
      "customFields": [
        {
          "ownerId": null,
          "name": null,
          "type": null,
          "value": null
        }
      ]
    }
  ],
  "count": "<integer>",
  "limit": "<integer>",
  "totalCount": "<integer>",
  "timestamp": "<date-time>",
  "nextCursor": "<string>",
  "hasMore": "<boolean>",
  "remainingCount": "<integer>"
}