GET api/v1/financialDocumentById?documentId={documentId}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| documentId | integer |
Required |
Body Parameters
None.
Response Information
Resource Description
GetFinancialDocumentByCriteriaModel| Name | Description | Type | Additional information |
|---|---|---|---|
| FinancialDocument | FinancialDocumentModel |
None. |
|
| FinancialDocumentExtended | FinancialDocumentExtendedModel |
None. |
|
| FinancialDocumentItems | Collection of FinancialDocumentItemModel |
None. |
|
| FinancialDocumentMapping | Collection of FinancialDocumentMappingModel |
None. |
|
| FinancialDocumentPayments | Collection of FinancialDocumentPaymentModel |
None. |
Response Formats
application/json, text/json
Sample:
{
"FinancialDocument": {
"Id": 1,
"Type": 64,
"Status": 64,
"CustomerId": 4,
"SerialNumber": 5,
"Created": "2025-12-10T17:32:28.3174019+02:00",
"DueDate": "2025-12-10T17:32:28.3174019+02:00",
"Subject": "sample string 7",
"Comment": "sample string 8",
"FooterContent": "sample string 9",
"EmailContent": "sample string 10",
"TotalBeforeVAT": 11.0,
"VAT": 12.0,
"TotalAfterVAT": 13.0,
"PrecentageDiscount": 14.0,
"FixedDiscount": 15.0,
"TotalDiscount": 16.0,
"TotalAfterDiscount": 17.0,
"VatType": 64,
"RoundAmountDiscount": 19.0,
"ExternalId": "1f9bf12e-8e5f-47c9-9c5d-bffb13119cdc",
"ExtendedInfo": "sample string 21",
"ExternalReportId": "sample string 22",
"HaveInterest": true,
"MonthlyInterestRate": 24.0,
"HaveIndex": true,
"IndexBase": 26.0,
"StartInterestAfter": "2025-12-10T17:32:28.3174019+02:00",
"ExternalSystemReference": "5ec97f36-04d2-4dbd-bbd7-ced37bf3b71d",
"ESignURL": "sample string 27"
},
"FinancialDocumentExtended": {
"Id": 1,
"Type": 64,
"Status": 64,
"CustomerId": 4,
"SerialNumber": 5,
"Created": "2025-12-10T17:32:28.3174019+02:00",
"DueDate": "2025-12-10T17:32:28.3174019+02:00",
"Subject": "sample string 7",
"Comment": "sample string 8",
"FooterContent": "sample string 9",
"EmailContent": "sample string 10",
"TotalBeforeVAT": 11.0,
"VAT": 12.0,
"TotalAfterVAT": 13.0,
"PrecentageDiscount": 14.0,
"FixedDiscount": 15.0,
"TotalDiscount": 16.0,
"TotalAfterDiscount": 17.0,
"VatType": 64,
"RoundAmountDiscount": 19.0,
"ExternalId": "7c25a13d-12f1-400b-8fb3-bf7e391e674d",
"ExtendedInfo": "sample string 21",
"ExternalReportId": "sample string 22",
"HaveInterest": true,
"MonthlyInterestRate": 24.0,
"HaveIndex": true,
"IndexBase": 26.0,
"StartInterestAfter": "2025-12-10T17:32:28.3330014+02:00",
"ExternalSystemReference": "a453ad84-2b56-4170-94c0-9400324dc926",
"Balance": 1.0,
"ESignURL": "sample string 27"
},
"FinancialDocumentItems": [
{
"Id": 1,
"FinancialDocumentId": 2,
"Name": "sample string 3",
"Description": "sample string 4",
"CatalogNumber": "sample string 5",
"Units": 64,
"UnitPrice": 7.0,
"TotalPriceBeforeVAT": 8.0,
"VAT": 9.0,
"TotalPrice": 10.0,
"VATType": 64,
"PriceListId": 12,
"PriceListType": 64
},
{
"Id": 1,
"FinancialDocumentId": 2,
"Name": "sample string 3",
"Description": "sample string 4",
"CatalogNumber": "sample string 5",
"Units": 64,
"UnitPrice": 7.0,
"TotalPriceBeforeVAT": 8.0,
"VAT": 9.0,
"TotalPrice": 10.0,
"VATType": 64,
"PriceListId": 12,
"PriceListType": 64
}
],
"FinancialDocumentMapping": [
{
"ResponseTofinancialDocumentId": 1,
"FromFinancialDocumentId": 2,
"Amount": 3.0,
"FinancialDocument": {
"Id": 1,
"Type": 64,
"Status": 64,
"CustomerId": 4,
"SerialNumber": 5,
"Created": "2025-12-10T17:32:28.3174019+02:00",
"DueDate": "2025-12-10T17:32:28.3174019+02:00",
"Subject": "sample string 7",
"Comment": "sample string 8",
"FooterContent": "sample string 9",
"EmailContent": "sample string 10",
"TotalBeforeVAT": 11.0,
"VAT": 12.0,
"TotalAfterVAT": 13.0,
"PrecentageDiscount": 14.0,
"FixedDiscount": 15.0,
"TotalDiscount": 16.0,
"TotalAfterDiscount": 17.0,
"VatType": 64,
"RoundAmountDiscount": 19.0,
"ExternalId": "1f9bf12e-8e5f-47c9-9c5d-bffb13119cdc",
"ExtendedInfo": "sample string 21",
"ExternalReportId": "sample string 22",
"HaveInterest": true,
"MonthlyInterestRate": 24.0,
"HaveIndex": true,
"IndexBase": 26.0,
"StartInterestAfter": "2025-12-10T17:32:28.3174019+02:00",
"ExternalSystemReference": "5ec97f36-04d2-4dbd-bbd7-ced37bf3b71d",
"ESignURL": "sample string 27"
}
},
{
"ResponseTofinancialDocumentId": 1,
"FromFinancialDocumentId": 2,
"Amount": 3.0,
"FinancialDocument": {
"Id": 1,
"Type": 64,
"Status": 64,
"CustomerId": 4,
"SerialNumber": 5,
"Created": "2025-12-10T17:32:28.3174019+02:00",
"DueDate": "2025-12-10T17:32:28.3174019+02:00",
"Subject": "sample string 7",
"Comment": "sample string 8",
"FooterContent": "sample string 9",
"EmailContent": "sample string 10",
"TotalBeforeVAT": 11.0,
"VAT": 12.0,
"TotalAfterVAT": 13.0,
"PrecentageDiscount": 14.0,
"FixedDiscount": 15.0,
"TotalDiscount": 16.0,
"TotalAfterDiscount": 17.0,
"VatType": 64,
"RoundAmountDiscount": 19.0,
"ExternalId": "1f9bf12e-8e5f-47c9-9c5d-bffb13119cdc",
"ExtendedInfo": "sample string 21",
"ExternalReportId": "sample string 22",
"HaveInterest": true,
"MonthlyInterestRate": 24.0,
"HaveIndex": true,
"IndexBase": 26.0,
"StartInterestAfter": "2025-12-10T17:32:28.3174019+02:00",
"ExternalSystemReference": "5ec97f36-04d2-4dbd-bbd7-ced37bf3b71d",
"ESignURL": "sample string 27"
}
}
],
"FinancialDocumentPayments": [
{
"Id": 1,
"FinancialDocumentId": 2,
"PaymentType": 64,
"Amount": 4.0,
"PaymentDate": "2025-12-10T17:32:28.3330014+02:00",
"Created": "2025-12-10T17:32:28.3330014+02:00",
"CreatedBy": "sample string 7",
"PaymentInfo": "sample string 8"
},
{
"Id": 1,
"FinancialDocumentId": 2,
"PaymentType": 64,
"Amount": 4.0,
"PaymentDate": "2025-12-10T17:32:28.3330014+02:00",
"Created": "2025-12-10T17:32:28.3330014+02:00",
"CreatedBy": "sample string 7",
"PaymentInfo": "sample string 8"
}
]
}
application/xml, text/xml
Sample:
<GetFinancialDocumentByCriteriaModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Emalogic.BillBee.Common.Models">
<FinancialDocument>
<Comment>sample string 8</Comment>
<Created>2025-12-10T17:32:28.3174019+02:00</Created>
<CustomerId>4</CustomerId>
<DueDate>2025-12-10T17:32:28.3174019+02:00</DueDate>
<ESignURL>sample string 27</ESignURL>
<EmailContent>sample string 10</EmailContent>
<ExtendedInfo>sample string 21</ExtendedInfo>
<ExternalId>1f9bf12e-8e5f-47c9-9c5d-bffb13119cdc</ExternalId>
<ExternalReportId>sample string 22</ExternalReportId>
<ExternalSystemReference>5ec97f36-04d2-4dbd-bbd7-ced37bf3b71d</ExternalSystemReference>
<FixedDiscount>15</FixedDiscount>
<FooterContent>sample string 9</FooterContent>
<HaveIndex>true</HaveIndex>
<HaveInterest>true</HaveInterest>
<Id>1</Id>
<IndexBase>26</IndexBase>
<MonthlyInterestRate>24</MonthlyInterestRate>
<PrecentageDiscount>14</PrecentageDiscount>
<RoundAmountDiscount>19</RoundAmountDiscount>
<SerialNumber>5</SerialNumber>
<StartInterestAfter>2025-12-10T17:32:28.3174019+02:00</StartInterestAfter>
<Status>64</Status>
<Subject>sample string 7</Subject>
<TotalAfterDiscount>17</TotalAfterDiscount>
<TotalAfterVAT>13</TotalAfterVAT>
<TotalBeforeVAT>11</TotalBeforeVAT>
<TotalDiscount>16</TotalDiscount>
<Type>64</Type>
<VAT>12</VAT>
<VatType>64</VatType>
</FinancialDocument>
<FinancialDocumentExtended>
<Balance>1</Balance>
<Comment>sample string 8</Comment>
<Created>2025-12-10T17:32:28.3174019+02:00</Created>
<CustomerId>4</CustomerId>
<DueDate>2025-12-10T17:32:28.3174019+02:00</DueDate>
<ESignURL>sample string 27</ESignURL>
<EmailContent>sample string 10</EmailContent>
<ExtendedInfo>sample string 21</ExtendedInfo>
<ExternalId>7c25a13d-12f1-400b-8fb3-bf7e391e674d</ExternalId>
<ExternalReportId>sample string 22</ExternalReportId>
<ExternalSystemReference>a453ad84-2b56-4170-94c0-9400324dc926</ExternalSystemReference>
<FixedDiscount>15</FixedDiscount>
<FooterContent>sample string 9</FooterContent>
<HaveIndex>true</HaveIndex>
<HaveInterest>true</HaveInterest>
<Id>1</Id>
<IndexBase>26</IndexBase>
<MonthlyInterestRate>24</MonthlyInterestRate>
<PrecentageDiscount>14</PrecentageDiscount>
<RoundAmountDiscount>19</RoundAmountDiscount>
<SerialNumber>5</SerialNumber>
<StartInterestAfter>2025-12-10T17:32:28.3330014+02:00</StartInterestAfter>
<Status>64</Status>
<Subject>sample string 7</Subject>
<TotalAfterDiscount>17</TotalAfterDiscount>
<TotalAfterVAT>13</TotalAfterVAT>
<TotalBeforeVAT>11</TotalBeforeVAT>
<TotalDiscount>16</TotalDiscount>
<Type>64</Type>
<VAT>12</VAT>
<VatType>64</VatType>
</FinancialDocumentExtended>
<FinancialDocumentItems>
<FinancialDocumentItemModel>
<CatalogNumber>sample string 5</CatalogNumber>
<Description>sample string 4</Description>
<FinancialDocumentId>2</FinancialDocumentId>
<Id>1</Id>
<Name>sample string 3</Name>
<PriceListId>12</PriceListId>
<PriceListType>64</PriceListType>
<TotalPrice>10</TotalPrice>
<TotalPriceBeforeVAT>8</TotalPriceBeforeVAT>
<UnitPrice>7</UnitPrice>
<Units>64</Units>
<VAT>9</VAT>
<VATType>64</VATType>
</FinancialDocumentItemModel>
<FinancialDocumentItemModel>
<CatalogNumber>sample string 5</CatalogNumber>
<Description>sample string 4</Description>
<FinancialDocumentId>2</FinancialDocumentId>
<Id>1</Id>
<Name>sample string 3</Name>
<PriceListId>12</PriceListId>
<PriceListType>64</PriceListType>
<TotalPrice>10</TotalPrice>
<TotalPriceBeforeVAT>8</TotalPriceBeforeVAT>
<UnitPrice>7</UnitPrice>
<Units>64</Units>
<VAT>9</VAT>
<VATType>64</VATType>
</FinancialDocumentItemModel>
</FinancialDocumentItems>
<FinancialDocumentMapping>
<FinancialDocumentMappingModel>
<Amount>3</Amount>
<FinancialDocument>
<Comment>sample string 8</Comment>
<Created>2025-12-10T17:32:28.3174019+02:00</Created>
<CustomerId>4</CustomerId>
<DueDate>2025-12-10T17:32:28.3174019+02:00</DueDate>
<ESignURL>sample string 27</ESignURL>
<EmailContent>sample string 10</EmailContent>
<ExtendedInfo>sample string 21</ExtendedInfo>
<ExternalId>1f9bf12e-8e5f-47c9-9c5d-bffb13119cdc</ExternalId>
<ExternalReportId>sample string 22</ExternalReportId>
<ExternalSystemReference>5ec97f36-04d2-4dbd-bbd7-ced37bf3b71d</ExternalSystemReference>
<FixedDiscount>15</FixedDiscount>
<FooterContent>sample string 9</FooterContent>
<HaveIndex>true</HaveIndex>
<HaveInterest>true</HaveInterest>
<Id>1</Id>
<IndexBase>26</IndexBase>
<MonthlyInterestRate>24</MonthlyInterestRate>
<PrecentageDiscount>14</PrecentageDiscount>
<RoundAmountDiscount>19</RoundAmountDiscount>
<SerialNumber>5</SerialNumber>
<StartInterestAfter>2025-12-10T17:32:28.3174019+02:00</StartInterestAfter>
<Status>64</Status>
<Subject>sample string 7</Subject>
<TotalAfterDiscount>17</TotalAfterDiscount>
<TotalAfterVAT>13</TotalAfterVAT>
<TotalBeforeVAT>11</TotalBeforeVAT>
<TotalDiscount>16</TotalDiscount>
<Type>64</Type>
<VAT>12</VAT>
<VatType>64</VatType>
</FinancialDocument>
<FromFinancialDocumentId>2</FromFinancialDocumentId>
<ResponseTofinancialDocumentId>1</ResponseTofinancialDocumentId>
</FinancialDocumentMappingModel>
<FinancialDocumentMappingModel>
<Amount>3</Amount>
<FinancialDocument>
<Comment>sample string 8</Comment>
<Created>2025-12-10T17:32:28.3174019+02:00</Created>
<CustomerId>4</CustomerId>
<DueDate>2025-12-10T17:32:28.3174019+02:00</DueDate>
<ESignURL>sample string 27</ESignURL>
<EmailContent>sample string 10</EmailContent>
<ExtendedInfo>sample string 21</ExtendedInfo>
<ExternalId>1f9bf12e-8e5f-47c9-9c5d-bffb13119cdc</ExternalId>
<ExternalReportId>sample string 22</ExternalReportId>
<ExternalSystemReference>5ec97f36-04d2-4dbd-bbd7-ced37bf3b71d</ExternalSystemReference>
<FixedDiscount>15</FixedDiscount>
<FooterContent>sample string 9</FooterContent>
<HaveIndex>true</HaveIndex>
<HaveInterest>true</HaveInterest>
<Id>1</Id>
<IndexBase>26</IndexBase>
<MonthlyInterestRate>24</MonthlyInterestRate>
<PrecentageDiscount>14</PrecentageDiscount>
<RoundAmountDiscount>19</RoundAmountDiscount>
<SerialNumber>5</SerialNumber>
<StartInterestAfter>2025-12-10T17:32:28.3174019+02:00</StartInterestAfter>
<Status>64</Status>
<Subject>sample string 7</Subject>
<TotalAfterDiscount>17</TotalAfterDiscount>
<TotalAfterVAT>13</TotalAfterVAT>
<TotalBeforeVAT>11</TotalBeforeVAT>
<TotalDiscount>16</TotalDiscount>
<Type>64</Type>
<VAT>12</VAT>
<VatType>64</VatType>
</FinancialDocument>
<FromFinancialDocumentId>2</FromFinancialDocumentId>
<ResponseTofinancialDocumentId>1</ResponseTofinancialDocumentId>
</FinancialDocumentMappingModel>
</FinancialDocumentMapping>
<FinancialDocumentPayments>
<FinancialDocumentPaymentModel>
<Amount>4</Amount>
<Created>2025-12-10T17:32:28.3330014+02:00</Created>
<CreatedBy>sample string 7</CreatedBy>
<FinancialDocumentId>2</FinancialDocumentId>
<Id>1</Id>
<PaymentDate>2025-12-10T17:32:28.3330014+02:00</PaymentDate>
<PaymentInfo>sample string 8</PaymentInfo>
<PaymentType>64</PaymentType>
</FinancialDocumentPaymentModel>
<FinancialDocumentPaymentModel>
<Amount>4</Amount>
<Created>2025-12-10T17:32:28.3330014+02:00</Created>
<CreatedBy>sample string 7</CreatedBy>
<FinancialDocumentId>2</FinancialDocumentId>
<Id>1</Id>
<PaymentDate>2025-12-10T17:32:28.3330014+02:00</PaymentDate>
<PaymentInfo>sample string 8</PaymentInfo>
<PaymentType>64</PaymentType>
</FinancialDocumentPaymentModel>
</FinancialDocumentPayments>
</GetFinancialDocumentByCriteriaModel>