GET v1/CreditNotes/GetCreditNotesSummary
Documentation for 'GetCreditNotesSummary'.
Request Information
Parameters
| Name | Description | Additional information |
|---|---|---|
| queryOptions | Documentation for 'queryOptions'. |
Define this parameter in the request URI. |
Response Information
Response body formats
application/json, text/json
Sample:
Click to beautify!
[
{
"netAmount": 1.0,
"creditNotesNumber": "sample string 2",
"reference": "sample string 3",
"customerId": 4,
"invoiceNumber": 5,
"invoiceId": 6,
"currency": "sample string 7",
"customerName": "sample string 8",
"customerCompany": "sample string 9",
"invoicePostedDate": "2024-05-03T13:11:42.8514793+00:00",
"effectiveTimestamp": "2024-05-03T13:11:42.8514793+00:00",
"creditNoteReference": "sample string 12",
"accountingStatus": "sample string 13",
"customerStatus": "sample string 14",
"customerIsParent": true,
"customerParentId": 1,
"customerFirstName": "sample string 16",
"customerLastName": "sample string 17",
"creditNoteStatus": "sample string 18",
"trigger": "sample string 19",
"triggeringUserId": 1,
"triggerUsername": "sample string 20",
"id": 21,
"uri": "sample string 22"
},
{
"netAmount": 1.0,
"creditNotesNumber": "sample string 2",
"reference": "sample string 3",
"customerId": 4,
"invoiceNumber": 5,
"invoiceId": 6,
"currency": "sample string 7",
"customerName": "sample string 8",
"customerCompany": "sample string 9",
"invoicePostedDate": "2024-05-03T13:11:42.8514793+00:00",
"effectiveTimestamp": "2024-05-03T13:11:42.8514793+00:00",
"creditNoteReference": "sample string 12",
"accountingStatus": "sample string 13",
"customerStatus": "sample string 14",
"customerIsParent": true,
"customerParentId": 1,
"customerFirstName": "sample string 16",
"customerLastName": "sample string 17",
"creditNoteStatus": "sample string 18",
"trigger": "sample string 19",
"triggeringUserId": 1,
"triggerUsername": "sample string 20",
"id": 21,
"uri": "sample string 22"
},
{
"netAmount": 1.0,
"creditNotesNumber": "sample string 2",
"reference": "sample string 3",
"customerId": 4,
"invoiceNumber": 5,
"invoiceId": 6,
"currency": "sample string 7",
"customerName": "sample string 8",
"customerCompany": "sample string 9",
"invoicePostedDate": "2024-05-03T13:11:42.8514793+00:00",
"effectiveTimestamp": "2024-05-03T13:11:42.8514793+00:00",
"creditNoteReference": "sample string 12",
"accountingStatus": "sample string 13",
"customerStatus": "sample string 14",
"customerIsParent": true,
"customerParentId": 1,
"customerFirstName": "sample string 16",
"customerLastName": "sample string 17",
"creditNoteStatus": "sample string 18",
"trigger": "sample string 19",
"triggeringUserId": 1,
"triggerUsername": "sample string 20",
"id": 21,
"uri": "sample string 22"
}
]
application/xml, text/xml
Sample:
Click to beautify!
<ArrayOfCreditNotes xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Common.Dto.Get">
<CreditNotes>
<Id>21</Id>
<Uri>sample string 22</Uri>
<AccountingStatus>sample string 13</AccountingStatus>
<CreditNoteReference>sample string 12</CreditNoteReference>
<CreditNoteStatus>sample string 18</CreditNoteStatus>
<CreditNotesNumber>sample string 2</CreditNotesNumber>
<Currency>sample string 7</Currency>
<CustomerCompany>sample string 9</CustomerCompany>
<CustomerFirstName>sample string 16</CustomerFirstName>
<CustomerId>4</CustomerId>
<CustomerIsParent>true</CustomerIsParent>
<CustomerLastName>sample string 17</CustomerLastName>
<CustomerName>sample string 8</CustomerName>
<CustomerParentId>1</CustomerParentId>
<CustomerStatus>sample string 14</CustomerStatus>
<EffectiveTimestamp>2024-05-03T13:11:42.8514793+00:00</EffectiveTimestamp>
<InvoiceId>6</InvoiceId>
<InvoiceNumber>5</InvoiceNumber>
<InvoicePostedDate>2024-05-03T13:11:42.8514793+00:00</InvoicePostedDate>
<NetAmount>1</NetAmount>
<Reference>sample string 3</Reference>
<Trigger>sample string 19</Trigger>
<TriggerUsername>sample string 20</TriggerUsername>
<TriggeringUserId>1</TriggeringUserId>
</CreditNotes>
<CreditNotes>
<Id>21</Id>
<Uri>sample string 22</Uri>
<AccountingStatus>sample string 13</AccountingStatus>
<CreditNoteReference>sample string 12</CreditNoteReference>
<CreditNoteStatus>sample string 18</CreditNoteStatus>
<CreditNotesNumber>sample string 2</CreditNotesNumber>
<Currency>sample string 7</Currency>
<CustomerCompany>sample string 9</CustomerCompany>
<CustomerFirstName>sample string 16</CustomerFirstName>
<CustomerId>4</CustomerId>
<CustomerIsParent>true</CustomerIsParent>
<CustomerLastName>sample string 17</CustomerLastName>
<CustomerName>sample string 8</CustomerName>
<CustomerParentId>1</CustomerParentId>
<CustomerStatus>sample string 14</CustomerStatus>
<EffectiveTimestamp>2024-05-03T13:11:42.8514793+00:00</EffectiveTimestamp>
<InvoiceId>6</InvoiceId>
<InvoiceNumber>5</InvoiceNumber>
<InvoicePostedDate>2024-05-03T13:11:42.8514793+00:00</InvoicePostedDate>
<NetAmount>1</NetAmount>
<Reference>sample string 3</Reference>
<Trigger>sample string 19</Trigger>
<TriggerUsername>sample string 20</TriggerUsername>
<TriggeringUserId>1</TriggeringUserId>
</CreditNotes>
<CreditNotes>
<Id>21</Id>
<Uri>sample string 22</Uri>
<AccountingStatus>sample string 13</AccountingStatus>
<CreditNoteReference>sample string 12</CreditNoteReference>
<CreditNoteStatus>sample string 18</CreditNoteStatus>
<CreditNotesNumber>sample string 2</CreditNotesNumber>
<Currency>sample string 7</Currency>
<CustomerCompany>sample string 9</CustomerCompany>
<CustomerFirstName>sample string 16</CustomerFirstName>
<CustomerId>4</CustomerId>
<CustomerIsParent>true</CustomerIsParent>
<CustomerLastName>sample string 17</CustomerLastName>
<CustomerName>sample string 8</CustomerName>
<CustomerParentId>1</CustomerParentId>
<CustomerStatus>sample string 14</CustomerStatus>
<EffectiveTimestamp>2024-05-03T13:11:42.8514793+00:00</EffectiveTimestamp>
<InvoiceId>6</InvoiceId>
<InvoiceNumber>5</InvoiceNumber>
<InvoicePostedDate>2024-05-03T13:11:42.8514793+00:00</InvoicePostedDate>
<NetAmount>1</NetAmount>
<Reference>sample string 3</Reference>
<Trigger>sample string 19</Trigger>
<TriggerUsername>sample string 20</TriggerUsername>
<TriggeringUserId>1</TriggeringUserId>
</CreditNotes>
</ArrayOfCreditNotes>