GET v1/Debits/{id}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

integer

Required

Body Parameters

None.

Response Information

Resource Description

Common.Dto.Get.Debit
NameDescriptionTypeAdditional information
reference

string

None.

effectiveTimestamp

date

None.

description

string

None.

customerId

integer

None.

originalCreditId

integer

None.

amount

decimal number

None.

currency

string

None.

invoiceAllocations

Collection of Common.Dto.Get.InvoiceAllocation

None.

trigger

string

None.

triggeringUserId

integer

None.

triggerUsername

string

None.

quickBooksId

integer

None.

quickBooksAttemptNumber

integer

None.

id

integer

None.

uri

string

None.

Response Formats

application/json, text/json

Sample:
{
  "reference": "sample string 1",
  "effectiveTimestamp": "2025-05-21T08:40:22.6492348+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"
}