GET v1/CreditNotes/{id}

Documentation for 'Get'.

Request Information

Parameters

NameDescriptionAdditional information
id
Documentation for 'id'.

Define this parameter in the request URI.

Response Information

Response body formats

application/json, text/json

Sample:
Click to beautify!
{
  "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": "2024-05-03T04:16:39.7500391+00:00",
  "effectiveTimestamp": "2024-05-03T04:16:39.7500391+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"
          }
        },
        {
          "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"
          }
        },
        {
          "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"
          }
        },
        {
          "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"
}

application/xml

Sample:
Click to beautify!

Sample not available.

text/xml

Sample:
Click to beautify!

Sample not available.