GET v1/CreditNotes/{id}

Request Information

URI Parameters

Name	Description	Type	Additional information
id		integer	Required

Body Parameters

None.

Response Information

Resource Description

Common.Dto.Get.CreditNoteDetails

Name	Type	Additional information
netAmount	decimal number	None.
grossAmount	decimal number	None.
voidedAmount	decimal number	None.
creditNotesNumber	string	None.
reference	string	None.
customerId	integer	None.
invoiceNumber	integer	None.
invoice	Common.Dto.Get.Invoice	None.
currency	string	None.
customerName	string	None.
customerCompany	string	None.
invoicePostedDate	date	None.
effectiveTimestamp	date	None.
lineItems	Collection of Common.Dto.Get.CreditNoteDetailsLineItemGroup	None.
netsuiteId	string	None.
netsuiteAccountId	string	None.
netsuiteAccountSubdomain	string	None.
creditNoteStatus	string	None.
trigger	string	None.
triggeringUserId	integer	None.
triggerUsername	string	None.
id	integer	None.
uri	string	None.

Response Formats

application/json, text/json

Sample:

{
  "netAmount": 1.0,
  "grossAmount": 2.0,
  "voidedAmount": 3.0,
  "creditNotesNumber": "sample string 4",
  "reference": "sample string 5",
  "customerId": 6,
  "invoiceNumber": 7,
  "invoice": null,
  "currency": "sample string 8",
  "customerName": "sample string 9",
  "customerCompany": "sample string 10",
  "invoicePostedDate": "2025-11-03T19:45:12.5541239+00:00",
  "effectiveTimestamp": "2025-11-03T19:45:12.5541239+00:00",
  "lineItems": [
    {
      "chargeGroupName": "sample string 1",
      "chargeGroupDescription": "sample string 2",
      "chargeGroupReference": "sample string 3",
      "lineItems": [
        {
          "lineItem": {
            "originalChargeId": 1,
            "netAmount": 2.0,
            "name": "sample string 3"
          },
          "taxes": {
            "netAmount": 1.0,
            "name": "sample string 2"
          },
          "discounts": {
            "netAmount": 1.0,
            "name": "sample string 2"
          }
        },
        {
          "lineItem": {
            "originalChargeId": 1,
            "netAmount": 2.0,
            "name": "sample string 3"
          },
          "taxes": {
            "netAmount": 1.0,
            "name": "sample string 2"
          },
          "discounts": {
            "netAmount": 1.0,
            "name": "sample string 2"
          }
        }
      ]
    },
    {
      "chargeGroupName": "sample string 1",
      "chargeGroupDescription": "sample string 2",
      "chargeGroupReference": "sample string 3",
      "lineItems": [
        {
          "lineItem": {
            "originalChargeId": 1,
            "netAmount": 2.0,
            "name": "sample string 3"
          },
          "taxes": {
            "netAmount": 1.0,
            "name": "sample string 2"
          },
          "discounts": {
            "netAmount": 1.0,
            "name": "sample string 2"
          }
        },
        {
          "lineItem": {
            "originalChargeId": 1,
            "netAmount": 2.0,
            "name": "sample string 3"
          },
          "taxes": {
            "netAmount": 1.0,
            "name": "sample string 2"
          },
          "discounts": {
            "netAmount": 1.0,
            "name": "sample string 2"
          }
        }
      ]
    }
  ],
  "netsuiteId": "sample string 13",
  "netsuiteAccountId": "sample string 14",
  "netsuiteAccountSubdomain": "sample string 15",
  "creditNoteStatus": "sample string 16",
  "trigger": "sample string 17",
  "triggeringUserId": 1,
  "triggerUsername": "sample string 18",
  "id": 19,
  "uri": "sample string 20"
}