POST v1/Credits

Request Information

URI Parameters

None.

Body Parameters

Common.Dto.Post.Credit

Name	Type	Additional information
reference	string	String length: inclusive between 0 and 255
customerId	integer	None.
amount	decimal number	Matching regular expression pattern: ^\d*.?\d{0,2}?$ Range: inclusive between 0.01 and 79228162514264337593543950335
creditAllocations	Collection of Common.Dto.Post.CreditAllocation	None.
netsuiteItemId	string	None.

Request Formats

application/json, text/json

Sample:

{
  "reference": "sample string 1",
  "customerId": 2,
  "amount": 3.0,
  "creditAllocations": [
    {
      "invoiceId": 1,
      "amount": 2.0
    },
    {
      "invoiceId": 1,
      "amount": 2.0
    }
  ],
  "netsuiteItemId": "sample string 4"
}

Response Information

Resource Description

Common.Dto.Get.Credit

Name	Type	Additional information
reference	string	None.
effectiveTimestamp	date	None.
description	string	None.
customerId	integer	None.
amount	decimal number	None.
currency	string	None.
unallocatedAmount	decimal number	None.
reversableAmount	decimal number	None.
invoiceAllocations	Collection of Common.Dto.Get.InvoiceAllocation	None.
debits	Collection of Common.Dto.Get.Debit	None.
netsuiteId	string	None.
netsuiteItemId	string	None.
netsuiteItemName	string	None.
netsuiteErrorReason	string	None.
trigger	string	None.
triggeringUserId	integer	None.
triggerUsername	string	None.
quickBooksId	integer	None.
quickBooksAttemptNumber	integer	None.
salesTrackingCode1Id	integer	None.
salesTrackingCode2Id	integer	None.
salesTrackingCode3Id	integer	None.
salesTrackingCode4Id	integer	None.
salesTrackingCode5Id	integer	None.
sageIntacctId	integer	None.
sageIntacctAttemptNumber	integer	None.
id	integer	None.
uri	string	None.

Response Formats

application/json, text/json

Sample:

{
  "reference": "sample string 1",
  "effectiveTimestamp": "2025-11-03T09:34:01.729874+00:00",
  "description": "sample string 3",
  "customerId": 4,
  "amount": 5.0,
  "currency": "sample string 6",
  "unallocatedAmount": 7.0,
  "reversableAmount": 8.0,
  "invoiceAllocations": [
    {
      "invoiceId": 1,
      "invoiceNumber": 2,
      "amount": 3.0,
      "outstandingBalance": 4.0,
      "invoiceTotal": 5.0,
      "surchargingFee": 1.0,
      "poNumber": "sample string 6",
      "netsuiteId": "sample string 7",
      "quickbooksId": 1,
      "invoiceNote": "sample string 8",
      "uri": "sample string 9"
    },
    {
      "invoiceId": 1,
      "invoiceNumber": 2,
      "amount": 3.0,
      "outstandingBalance": 4.0,
      "invoiceTotal": 5.0,
      "surchargingFee": 1.0,
      "poNumber": "sample string 6",
      "netsuiteId": "sample string 7",
      "quickbooksId": 1,
      "invoiceNote": "sample string 8",
      "uri": "sample string 9"
    }
  ],
  "debits": [
    {
      "reference": "sample string 1",
      "effectiveTimestamp": "2025-11-03T09:34:01.729874+00:00",
      "description": "sample string 3",
      "customerId": 4,
      "originalCreditId": 5,
      "amount": 6.0,
      "currency": "sample string 7",
      "invoiceAllocations": [
        {
          "invoiceId": 1,
          "invoiceNumber": 2,
          "amount": 3.0,
          "outstandingBalance": 4.0,
          "invoiceTotal": 5.0,
          "surchargingFee": 1.0,
          "poNumber": "sample string 6",
          "netsuiteId": "sample string 7",
          "quickbooksId": 1,
          "invoiceNote": "sample string 8",
          "uri": "sample string 9"
        },
        {
          "invoiceId": 1,
          "invoiceNumber": 2,
          "amount": 3.0,
          "outstandingBalance": 4.0,
          "invoiceTotal": 5.0,
          "surchargingFee": 1.0,
          "poNumber": "sample string 6",
          "netsuiteId": "sample string 7",
          "quickbooksId": 1,
          "invoiceNote": "sample string 8",
          "uri": "sample string 9"
        }
      ],
      "trigger": "sample string 8",
      "triggeringUserId": 1,
      "triggerUsername": "sample string 9",
      "quickBooksId": 1,
      "quickBooksAttemptNumber": 10,
      "id": 11,
      "uri": "sample string 12"
    },
    {
      "reference": "sample string 1",
      "effectiveTimestamp": "2025-11-03T09:34:01.729874+00:00",
      "description": "sample string 3",
      "customerId": 4,
      "originalCreditId": 5,
      "amount": 6.0,
      "currency": "sample string 7",
      "invoiceAllocations": [
        {
          "invoiceId": 1,
          "invoiceNumber": 2,
          "amount": 3.0,
          "outstandingBalance": 4.0,
          "invoiceTotal": 5.0,
          "surchargingFee": 1.0,
          "poNumber": "sample string 6",
          "netsuiteId": "sample string 7",
          "quickbooksId": 1,
          "invoiceNote": "sample string 8",
          "uri": "sample string 9"
        },
        {
          "invoiceId": 1,
          "invoiceNumber": 2,
          "amount": 3.0,
          "outstandingBalance": 4.0,
          "invoiceTotal": 5.0,
          "surchargingFee": 1.0,
          "poNumber": "sample string 6",
          "netsuiteId": "sample string 7",
          "quickbooksId": 1,
          "invoiceNote": "sample string 8",
          "uri": "sample string 9"
        }
      ],
      "trigger": "sample string 8",
      "triggeringUserId": 1,
      "triggerUsername": "sample string 9",
      "quickBooksId": 1,
      "quickBooksAttemptNumber": 10,
      "id": 11,
      "uri": "sample string 12"
    }
  ],
  "netsuiteId": "sample string 9",
  "netsuiteItemId": "sample string 10",
  "netsuiteItemName": "sample string 11",
  "netsuiteErrorReason": "sample string 12",
  "trigger": "sample string 13",
  "triggeringUserId": 1,
  "triggerUsername": "sample string 14",
  "quickBooksId": 1,
  "quickBooksAttemptNumber": 15,
  "salesTrackingCode1Id": 1,
  "salesTrackingCode2Id": 1,
  "salesTrackingCode3Id": 1,
  "salesTrackingCode4Id": 1,
  "salesTrackingCode5Id": 1,
  "sageIntacctId": 1,
  "sageIntacctAttemptNumber": 16,
  "id": 17,
  "uri": "sample string 18"
}