Retrieve Credit Memo

Returns a specific CreditMemo by its unique identifier.

Loading API schema for CreditMemo…

GET/api/v1/credit-memo/{id}

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

Response200

{
  "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": "<string>",
      "id": "<string>",
      "item": {
        "id": null,
        "fullname": null
      },
      "description": "<string>",
      "quantity": "<number>",
      "unitOfMeasure": "<string>",
      "overrideUnitOfMeasureSet": {
        "id": null,
        "fullname": null
      },
      "rate": "<number>",
      "ratePercent": "<number>",
      "class": {
        "id": null,
        "fullname": null
      },
      "amount": "<number>",
      "inventorySite": {
        "id": null,
        "fullname": null
      },
      "inventorySiteLocation": {
        "id": null,
        "fullname": null
      },
      "serialNumber": "<string>",
      "lotNumber": "<string>",
      "expirationDate": "<string>",
      "serviceDate": "<date>",
      "salesTaxCode": {
        "id": null,
        "fullname": null
      },
      "otherCustomField1": "<string>",
      "otherCustomField2": "<string>",
      "creditCardTransaction": {
        "request": null,
        "response": null
      },
      "customFields": []
    }
  ],
  "lineGroups": [
    {
      "id": "<string>",
      "objectType": "<string>",
      "itemGroup": {
        "id": null,
        "fullname": null
      },
      "description": "<string>",
      "quantity": "<number>",
      "unitOfMeasure": "<string>",
      "overrideUnitOfMeasureSet": {
        "id": null,
        "fullname": null
      },
      "shouldPrintItemsInGroup": "<boolean>",
      "totalAmount": "<number>",
      "lines": [],
      "customFields": []
    }
  ],
  "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": {
        "id": "<string>",
        "fullname": "<string>"
      },
      "amount": "<number>",
      "memo": "<string>",
      "class": {
        "id": "<string>",
        "fullname": "<string>"
      },
      "customer": {
        "id": "<string>",
        "fullname": "<string>"
      },
      "salesRepresentative": {
        "id": "<string>",
        "fullname": "<string>"
      },
      "salesTaxCode": {
        "id": "<string>",
        "fullname": "<string>"
      },
      "taxAmount": "<number>",
      "vendor": {
        "id": "<string>",
        "fullname": "<string>"
      },
      "billableStatus": "NotBillable",
      "customFields": [
        {
          "ownerId": null,
          "name": null,
          "type": null,
          "value": null
        }
      ]
    }
  ],
  "itemLines": [
    {
      "id": "<string>",
      "objectType": "<string>",
      "otherCustomField1": "<string>",
      "otherCustomField2": "<string>",
      "item": {
        "id": "<string>",
        "fullname": "<string>"
      },
      "description": "<string>",
      "quantity": "<number>",
      "cost": "<number>",
      "amount": "<number>",
      "customer": {
        "id": "<string>",
        "fullname": "<string>"
      },
      "class": {
        "id": "<string>",
        "fullname": "<string>"
      },
      "overrideItemAccount": {
        "id": "<string>",
        "fullname": "<string>"
      },
      "billableStatus": "NotBillable",
      "itemGroup": {
        "id": "<string>",
        "fullname": "<string>"
      },
      "unitOfMeasure": "<string>",
      "rate": "<number>",
      "salesTaxCode": {
        "id": "<string>",
        "fullname": "<string>"
      },
      "inventorySite": {
        "id": "<string>",
        "fullname": "<string>"
      },
      "inventorySiteLocation": {
        "id": "<string>",
        "fullname": "<string>"
      },
      "serialNumber": "<string>",
      "lotNumber": "<string>",
      "serviceDate": "<date>",
      "customFields": [
        {
          "ownerId": null,
          "name": null,
          "type": null,
          "value": null
        }
      ]
    }
  ],
  "itemGroupLines": [
    {
      "id": "<string>",
      "objectType": "<string>",
      "itemGroup": {
        "id": "<string>",
        "fullname": "<string>"
      },
      "description": "<string>",
      "quantity": "<number>",
      "totalAmount": "<number>",
      "unitOfMeasure": "<string>",
      "isPrintItemsInGroup": "<boolean>",
      "lines": [
        {
          "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
        }
      ],
      "customFields": [
        {
          "ownerId": null,
          "name": null,
          "type": null,
          "value": null
        }
      ]
    }
  ],
  "customFields": [
    {
      "ownerId": "<string>",
      "name": "<string>",
      "type": "<string>",
      "value": "<string>"
    }
  ]
}