GET v1/Credits/{id}
Documentation for 'Get'.
Request Information
Parameters
| Name | Description | Additional 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!
{
"reference": "sample string 1",
"effectiveTimestamp": "2024-05-03T03:58:42.4767095+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"
},
{
"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": "2024-05-03T03:58:42.4923861+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"
},
{
"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": "2024-05-03T03:58:42.4923861+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"
},
{
"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": "2024-05-03T03:58:42.4923861+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"
},
{
"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,
"id": 16,
"uri": "sample string 17"
}
application/xml, text/xml
Sample:
Click to beautify!
<Credit xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Common.Dto.Get">
<Id>16</Id>
<Uri>sample string 17</Uri>
<Amount>5</Amount>
<Currency>sample string 6</Currency>
<CustomerId>4</CustomerId>
<Debits>
<Debit>
<Id>11</Id>
<Uri>sample string 12</Uri>
<Amount>6</Amount>
<Currency>sample string 7</Currency>
<CustomerId>4</CustomerId>
<Description>sample string 3</Description>
<EffectiveTimestamp>2024-05-03T03:58:42.4923861+00:00</EffectiveTimestamp>
<InvoiceAllocations>
<InvoiceAllocation>
<Amount>3</Amount>
<InvoiceId>1</InvoiceId>
<InvoiceNote>sample string 8</InvoiceNote>
<InvoiceNumber>2</InvoiceNumber>
<InvoiceTotal>5</InvoiceTotal>
<NetsuiteId>sample string 7</NetsuiteId>
<OutstandingBalance>4</OutstandingBalance>
<PoNumber>sample string 6</PoNumber>
<QuickbooksId>1</QuickbooksId>
<SurchargingFee>1</SurchargingFee>
<Uri>sample string 9</Uri>
</InvoiceAllocation>
<InvoiceAllocation>
<Amount>3</Amount>
<InvoiceId>1</InvoiceId>
<InvoiceNote>sample string 8</InvoiceNote>
<InvoiceNumber>2</InvoiceNumber>
<InvoiceTotal>5</InvoiceTotal>
<NetsuiteId>sample string 7</NetsuiteId>
<OutstandingBalance>4</OutstandingBalance>
<PoNumber>sample string 6</PoNumber>
<QuickbooksId>1</QuickbooksId>
<SurchargingFee>1</SurchargingFee>
<Uri>sample string 9</Uri>
</InvoiceAllocation>
<InvoiceAllocation>
<Amount>3</Amount>
<InvoiceId>1</InvoiceId>
<InvoiceNote>sample string 8</InvoiceNote>
<InvoiceNumber>2</InvoiceNumber>
<InvoiceTotal>5</InvoiceTotal>
<NetsuiteId>sample string 7</NetsuiteId>
<OutstandingBalance>4</OutstandingBalance>
<PoNumber>sample string 6</PoNumber>
<QuickbooksId>1</QuickbooksId>
<SurchargingFee>1</SurchargingFee>
<Uri>sample string 9</Uri>
</InvoiceAllocation>
</InvoiceAllocations>
<OriginalCreditId>5</OriginalCreditId>
<QuickBooksAttemptNumber>10</QuickBooksAttemptNumber>
<QuickBooksId>1</QuickBooksId>
<Reference>sample string 1</Reference>
<Trigger>sample string 8</Trigger>
<TriggerUsername>sample string 9</TriggerUsername>
<TriggeringUserId>1</TriggeringUserId>
</Debit>
<Debit>
<Id>11</Id>
<Uri>sample string 12</Uri>
<Amount>6</Amount>
<Currency>sample string 7</Currency>
<CustomerId>4</CustomerId>
<Description>sample string 3</Description>
<EffectiveTimestamp>2024-05-03T03:58:42.4923861+00:00</EffectiveTimestamp>
<InvoiceAllocations>
<InvoiceAllocation>
<Amount>3</Amount>
<InvoiceId>1</InvoiceId>
<InvoiceNote>sample string 8</InvoiceNote>
<InvoiceNumber>2</InvoiceNumber>
<InvoiceTotal>5</InvoiceTotal>
<NetsuiteId>sample string 7</NetsuiteId>
<OutstandingBalance>4</OutstandingBalance>
<PoNumber>sample string 6</PoNumber>
<QuickbooksId>1</QuickbooksId>
<SurchargingFee>1</SurchargingFee>
<Uri>sample string 9</Uri>
</InvoiceAllocation>
<InvoiceAllocation>
<Amount>3</Amount>
<InvoiceId>1</InvoiceId>
<InvoiceNote>sample string 8</InvoiceNote>
<InvoiceNumber>2</InvoiceNumber>
<InvoiceTotal>5</InvoiceTotal>
<NetsuiteId>sample string 7</NetsuiteId>
<OutstandingBalance>4</OutstandingBalance>
<PoNumber>sample string 6</PoNumber>
<QuickbooksId>1</QuickbooksId>
<SurchargingFee>1</SurchargingFee>
<Uri>sample string 9</Uri>
</InvoiceAllocation>
<InvoiceAllocation>
<Amount>3</Amount>
<InvoiceId>1</InvoiceId>
<InvoiceNote>sample string 8</InvoiceNote>
<InvoiceNumber>2</InvoiceNumber>
<InvoiceTotal>5</InvoiceTotal>
<NetsuiteId>sample string 7</NetsuiteId>
<OutstandingBalance>4</OutstandingBalance>
<PoNumber>sample string 6</PoNumber>
<QuickbooksId>1</QuickbooksId>
<SurchargingFee>1</SurchargingFee>
<Uri>sample string 9</Uri>
</InvoiceAllocation>
</InvoiceAllocations>
<OriginalCreditId>5</OriginalCreditId>
<QuickBooksAttemptNumber>10</QuickBooksAttemptNumber>
<QuickBooksId>1</QuickBooksId>
<Reference>sample string 1</Reference>
<Trigger>sample string 8</Trigger>
<TriggerUsername>sample string 9</TriggerUsername>
<TriggeringUserId>1</TriggeringUserId>
</Debit>
<Debit>
<Id>11</Id>
<Uri>sample string 12</Uri>
<Amount>6</Amount>
<Currency>sample string 7</Currency>
<CustomerId>4</CustomerId>
<Description>sample string 3</Description>
<EffectiveTimestamp>2024-05-03T03:58:42.4923861+00:00</EffectiveTimestamp>
<InvoiceAllocations>
<InvoiceAllocation>
<Amount>3</Amount>
<InvoiceId>1</InvoiceId>
<InvoiceNote>sample string 8</InvoiceNote>
<InvoiceNumber>2</InvoiceNumber>
<InvoiceTotal>5</InvoiceTotal>
<NetsuiteId>sample string 7</NetsuiteId>
<OutstandingBalance>4</OutstandingBalance>
<PoNumber>sample string 6</PoNumber>
<QuickbooksId>1</QuickbooksId>
<SurchargingFee>1</SurchargingFee>
<Uri>sample string 9</Uri>
</InvoiceAllocation>
<InvoiceAllocation>
<Amount>3</Amount>
<InvoiceId>1</InvoiceId>
<InvoiceNote>sample string 8</InvoiceNote>
<InvoiceNumber>2</InvoiceNumber>
<InvoiceTotal>5</InvoiceTotal>
<NetsuiteId>sample string 7</NetsuiteId>
<OutstandingBalance>4</OutstandingBalance>
<PoNumber>sample string 6</PoNumber>
<QuickbooksId>1</QuickbooksId>
<SurchargingFee>1</SurchargingFee>
<Uri>sample string 9</Uri>
</InvoiceAllocation>
<InvoiceAllocation>
<Amount>3</Amount>
<InvoiceId>1</InvoiceId>
<InvoiceNote>sample string 8</InvoiceNote>
<InvoiceNumber>2</InvoiceNumber>
<InvoiceTotal>5</InvoiceTotal>
<NetsuiteId>sample string 7</NetsuiteId>
<OutstandingBalance>4</OutstandingBalance>
<PoNumber>sample string 6</PoNumber>
<QuickbooksId>1</QuickbooksId>
<SurchargingFee>1</SurchargingFee>
<Uri>sample string 9</Uri>
</InvoiceAllocation>
</InvoiceAllocations>
<OriginalCreditId>5</OriginalCreditId>
<QuickBooksAttemptNumber>10</QuickBooksAttemptNumber>
<QuickBooksId>1</QuickBooksId>
<Reference>sample string 1</Reference>
<Trigger>sample string 8</Trigger>
<TriggerUsername>sample string 9</TriggerUsername>
<TriggeringUserId>1</TriggeringUserId>
</Debit>
</Debits>
<Description>sample string 3</Description>
<EffectiveTimestamp>2024-05-03T03:58:42.4767095+00:00</EffectiveTimestamp>
<InvoiceAllocations>
<InvoiceAllocation>
<Amount>3</Amount>
<InvoiceId>1</InvoiceId>
<InvoiceNote>sample string 8</InvoiceNote>
<InvoiceNumber>2</InvoiceNumber>
<InvoiceTotal>5</InvoiceTotal>
<NetsuiteId>sample string 7</NetsuiteId>
<OutstandingBalance>4</OutstandingBalance>
<PoNumber>sample string 6</PoNumber>
<QuickbooksId>1</QuickbooksId>
<SurchargingFee>1</SurchargingFee>
<Uri>sample string 9</Uri>
</InvoiceAllocation>
<InvoiceAllocation>
<Amount>3</Amount>
<InvoiceId>1</InvoiceId>
<InvoiceNote>sample string 8</InvoiceNote>
<InvoiceNumber>2</InvoiceNumber>
<InvoiceTotal>5</InvoiceTotal>
<NetsuiteId>sample string 7</NetsuiteId>
<OutstandingBalance>4</OutstandingBalance>
<PoNumber>sample string 6</PoNumber>
<QuickbooksId>1</QuickbooksId>
<SurchargingFee>1</SurchargingFee>
<Uri>sample string 9</Uri>
</InvoiceAllocation>
<InvoiceAllocation>
<Amount>3</Amount>
<InvoiceId>1</InvoiceId>
<InvoiceNote>sample string 8</InvoiceNote>
<InvoiceNumber>2</InvoiceNumber>
<InvoiceTotal>5</InvoiceTotal>
<NetsuiteId>sample string 7</NetsuiteId>
<OutstandingBalance>4</OutstandingBalance>
<PoNumber>sample string 6</PoNumber>
<QuickbooksId>1</QuickbooksId>
<SurchargingFee>1</SurchargingFee>
<Uri>sample string 9</Uri>
</InvoiceAllocation>
</InvoiceAllocations>
<NetsuiteErrorReason>sample string 12</NetsuiteErrorReason>
<NetsuiteId>sample string 9</NetsuiteId>
<NetsuiteItemId>sample string 10</NetsuiteItemId>
<NetsuiteItemName>sample string 11</NetsuiteItemName>
<QuickBooksAttemptNumber>15</QuickBooksAttemptNumber>
<QuickBooksId>1</QuickBooksId>
<Reference>sample string 1</Reference>
<ReversableAmount>8</ReversableAmount>
<SalesTrackingCode1Id>1</SalesTrackingCode1Id>
<SalesTrackingCode2Id>1</SalesTrackingCode2Id>
<SalesTrackingCode3Id>1</SalesTrackingCode3Id>
<SalesTrackingCode4Id>1</SalesTrackingCode4Id>
<SalesTrackingCode5Id>1</SalesTrackingCode5Id>
<Trigger>sample string 13</Trigger>
<TriggerUsername>sample string 14</TriggerUsername>
<TriggeringUserId>1</TriggeringUserId>
<UnallocatedAmount>7</UnallocatedAmount>
</Credit>