GET api/invoice/{invoiceNo}/{includeInternal}
Retrieve a single invoice by invoice number
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| invoiceNo |
Passed invoice number to filter by |
integer |
Required |
| includeInternal |
Include internal invoices |
boolean |
Default value is False |
Body Parameters
None.
Remarks
None.
Example
None.
Response Information
Resource Description
InvoiceHeadResponse if match, 204 status code if empty
InvoiceHeadResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| No | integer |
None. |
|
| InvoiceType | InvoiceTypeResponse |
None. |
|
| InvoiceDate | date |
None. |
|
| JournalNumber | integer |
None. |
|
| CurrencyCode | string |
None. |
|
| CurrencyRate | decimal number |
None. |
|
| BalanceDue | date |
None. |
|
| InvoiceFee | decimal number |
None. |
|
| Amount | decimal number |
None. |
|
| VatAmount | decimal number |
None. |
|
| RoundingAmount | decimal number |
None. |
|
| TotalAmount | decimal number |
None. |
|
| DiscountBalanceDue | date |
None. |
|
| DiscountVatAmount | decimal number |
None. |
|
| DiscountRoundingAmount | decimal number |
None. |
|
| DiscountTotalAmount | decimal number |
None. |
|
| InvoiceReferenceCode | string |
None. |
|
| InvoiceText | string |
None. |
|
| InvoiceRecipientId | globally unique identifier |
None. |
|
| InvoiceRecipientName | string |
None. |
|
| SenderName | string |
None. |
|
| DefaultVatPercent | decimal number |
None. |
|
| Created | date |
None. |
Response Formats
application/json, text/json
Sample:
{
"No": 1,
"InvoiceType": {
"Id": 1,
"Name": "sample string 1"
},
"InvoiceDate": "2026-01-21 22:50:59",
"JournalNumber": 1,
"CurrencyCode": "sample string 3",
"CurrencyRate": 4.0,
"BalanceDue": "2026-01-21 22:50:59",
"InvoiceFee": 1.0,
"Amount": 1.0,
"VatAmount": 1.0,
"RoundingAmount": 1.0,
"TotalAmount": 1.0,
"DiscountBalanceDue": "2026-01-21 22:50:59",
"DiscountVatAmount": 1.0,
"DiscountRoundingAmount": 1.0,
"DiscountTotalAmount": 1.0,
"InvoiceReferenceCode": "sample string 5",
"InvoiceText": "sample string 6",
"InvoiceRecipientId": "2b51f292-b878-4ee1-a4ae-a11b165bd553",
"InvoiceRecipientName": "sample string 7",
"SenderName": "sample string 8",
"DefaultVatPercent": 1.0,
"Created": "2026-01-21 22:50:59"
}
application/xml, text/xml
Sample:
<InvoiceHeadResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Compilator.DDAPI.DTO.Invocie">
<Amount>1</Amount>
<BalanceDue>2026-01-21T22:50:59.1623903+01:00</BalanceDue>
<Created>2026-01-21T22:50:59.1623903+01:00</Created>
<CurrencyCode>sample string 3</CurrencyCode>
<CurrencyRate>4</CurrencyRate>
<DefaultVatPercent>1</DefaultVatPercent>
<DiscountBalanceDue>2026-01-21T22:50:59.1623903+01:00</DiscountBalanceDue>
<DiscountRoundingAmount>1</DiscountRoundingAmount>
<DiscountTotalAmount>1</DiscountTotalAmount>
<DiscountVatAmount>1</DiscountVatAmount>
<InvoiceDate>2026-01-21T22:50:59.1623903+01:00</InvoiceDate>
<InvoiceFee>1</InvoiceFee>
<InvoiceRecipientId>2b51f292-b878-4ee1-a4ae-a11b165bd553</InvoiceRecipientId>
<InvoiceRecipientName>sample string 7</InvoiceRecipientName>
<InvoiceReferenceCode>sample string 5</InvoiceReferenceCode>
<InvoiceText>sample string 6</InvoiceText>
<InvoiceType>
<Id>NormalInvoice</Id>
<Name>sample string 1</Name>
</InvoiceType>
<JournalNumber>1</JournalNumber>
<No>1</No>
<RoundingAmount>1</RoundingAmount>
<SenderName>sample string 8</SenderName>
<TotalAmount>1</TotalAmount>
<VatAmount>1</VatAmount>
</InvoiceHeadResponse>
