GET api/Invoice/GetInvoice/{invoiceYear}/{invoiceBook}/{invoiceNumber}

Request Information

URI Parameters

Name	Type	Additional information
invoiceYear	integer	Required
invoiceBook	string	Required
invoiceNumber	integer	Required

Body Parameters

None.

Response Information

Resource Description

InvoiceHeaderDetail

Name	Type	Additional information
InvoiceYear	integer	None.
InvoiceBook	string	None.
InvoiceNumber	integer	None.
CustomerPayerID	string	None.
PayerTitle1	string	None.
PayerTitle2	string	None.
PayerTitle3	string	None.
PayerAddress	string	None.
PayerHouseNo	string	None.
PayerPostalCode	string	None.
PayerCity	string	None.
PayerCountry	string	None.
PayerTaxNumber	string	None.
CustomerID	string	None.
RecipientTitle1	string	None.
RecipientTitle2	string	None.
RecipientTitle3	string	None.
RecipientAddress	string	None.
RecipientHouseNo	string	None.
RecipientPostalCode	string	None.
RecipientCity	string	None.
RecipientCountry	string	None.
RecipientShopID	string	None.
RecipientTaxNumber	string	None.
DeliveryTitle1	string	None.
DeliveryTitle2	string	None.
DeliveryTitle3	string	None.
DeliveryAddress	string	None.
DeliveryHouseNo	string	None.
DeliveryPostalCode	string	None.
DeliveryCity	string	None.
DeliveryCountry	string	None.
InvoiceDate	date	None.
DeliveryDateFrom	date	None.
DeliveryDateTo	date	None.
DueDate	date	None.
PaymentReference	string	None.
CurrencyID	string	None.
ExchangeRateDate	date	None.
ExchangeRate	decimal number	None.
ExchangeRateBase	integer	None.
ExchangeRateID	string	None.
CurrencyClause	boolean	None.
Document	string	None.
Comment	string	None.
DocumentHeaderDescription	string	None.
DocumentFooterDescription	string	None.
LanguageID	string	None.
VATCalculated	string	None.
VATInvoiceType	string	None.
DistanceSale	boolean	None.
AssemblingAndInstallation	boolean	None.
VAT_NonTaxable_Deduction	boolean	None.
Status	string	None.
StatusDate	date	None.
StatusLines	string	None.
PriceListID	string	None.
RebatePercentage	decimal number	None.
RebatePercentage2	decimal number	None.
RebatePercentage3	decimal number	None.
RebatePercentage4	decimal number	None.
RebatePercentage5	decimal number	None.
GrossAmout	decimal number	None.
DiscountAmount	decimal number	None.
RebateAmount	decimal number	None.
NetAmount	decimal number	None.
VATAmount	decimal number	None.
RoundingAmount	decimal number	None.
PaymentAmount	decimal number	None.
AdvancePaymentAmount	decimal number	None.
VATAdvancePaymentAmount	decimal number	None.
RoundingAdvancePaymentAmount	decimal number	None.
PaymentAdvancePaymentAmount	decimal number	None.
RebateAmountAmount	decimal number	None.
InsertedBy	string	None.
InsertedTime	date	None.
ModifiedBy	string	None.
ModifiedTime	date	None.
CostCenterID	string	None.
CostUnitID	string	None.
WorkOrderID	string	None.
ClerkID	string	None.
AnalyticID	string	None.
PayerCostCenterID	string	None.
AccountingBookGroupID	string	None.
ApplicationName	string	None.
LinkToDocument	string	None.
AccountingDescription	string	None.
InstallmentPayment	boolean	None.
NumberOfInstallmentPayment	integer	None.
CashTransactionsReference	integer	None.
CashTransactionsID	string	None.
TaxNumberSecondary	string	None.
CustomerClerkName	string	None.
CustomerClerkID	string	None.
DeliveryType	string	None.
DeliveryPlace	string	None.
PaymentCodeID	string	None.
EnvironmentalTaxAmount	decimal number	None.
ParityCode	string	None.
ParityPlace	string	None.
AuthorizationCode	string	None.
DocumentSalesType	string	None.
CashOperation	boolean	None.
CashierID	string	None.
PaymentPurposeId	string	None.
Analytic_AN1_ID	string	None.
Analytic_AN2_ID	string	None.
Analytic_AN3_ID	string	None.
DateVD	string	None.
CodeVD	string	None.
CodeVR	string	None.
DiscountGroupID	string	None.
AttachmentID	string	None.
AnnexID	string	None.
FolderID	string	None.
eInvoiceAttachmentID	string	None.
DPR_InvoiceNo	string	None.
PaymentReferenceExternal	string	None.
ContactPerson	string	None.
InstallmentsPayment	boolean	None.
NumberOfInstallments	integer	None.
InvoiceID	string	None.
VATTaxCategory	string	None.
FiscalizationDate	string	None.
UniqueInvoiceID	string	None.
SecurityCodeOfInvoice	string	None.
LocationID	string	None.
DeliveryLocationAddress	string	None.
ContactTypeID	string	None.
ContactInTypeID	integer	None.
InvoiceLines	InvoiceLine_	None.
InvoiceInstallments	InvoiceInstallment_	None.
InvoiceAdvancePayments	InvoiceAdvancePayment_	None.
InvoicePayments	InvoicePayments	None.

Response Formats

application/xml, text/xml

Sample:

<InvoiceHeader xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <InvoiceYear>1</InvoiceYear>
  <InvoiceBook>sample string 2</InvoiceBook>
  <InvoiceNumber>3</InvoiceNumber>
  <CustomerPayerID>sample string 4</CustomerPayerID>
  <PayerTitle1>sample string 5</PayerTitle1>
  <PayerTitle2>sample string 6</PayerTitle2>
  <PayerTitle3>sample string 7</PayerTitle3>
  <PayerAddress>sample string 8</PayerAddress>
  <PayerHouseNo>sample string 9</PayerHouseNo>
  <PayerPostalCode>sample string 10</PayerPostalCode>
  <PayerCity>sample string 11</PayerCity>
  <PayerCountry>sample string 12</PayerCountry>
  <PayerTaxNumber>sample string 13</PayerTaxNumber>
  <CustomerID>sample string 14</CustomerID>
  <RecipientTitle1>sample string 15</RecipientTitle1>
  <RecipientTitle2>sample string 16</RecipientTitle2>
  <RecipientTitle3>sample string 17</RecipientTitle3>
  <RecipientAddress>sample string 18</RecipientAddress>
  <RecipientHouseNo>sample string 19</RecipientHouseNo>
  <RecipientPostalCode>sample string 20</RecipientPostalCode>
  <RecipientCity>sample string 21</RecipientCity>
  <RecipientCountry>sample string 22</RecipientCountry>
  <RecipientShopID>sample string 23</RecipientShopID>
  <RecipientTaxNumber>sample string 24</RecipientTaxNumber>
  <DeliveryTitle1>sample string 25</DeliveryTitle1>
  <DeliveryTitle2>sample string 26</DeliveryTitle2>
  <DeliveryTitle3>sample string 27</DeliveryTitle3>
  <DeliveryAddress>sample string 28</DeliveryAddress>
  <DeliveryHouseNo>sample string 29</DeliveryHouseNo>
  <DeliveryPostalCode>sample string 30</DeliveryPostalCode>
  <DeliveryCity>sample string 31</DeliveryCity>
  <DeliveryCountry>sample string 32</DeliveryCountry>
  <InvoiceDate>2024-11-23T03:59:40.3571109+01:00</InvoiceDate>
  <DeliveryDateFrom>2024-11-23T03:59:40.3571109+01:00</DeliveryDateFrom>
  <DeliveryDateTo>2024-11-23T03:59:40.3571109+01:00</DeliveryDateTo>
  <DueDate>2024-11-23T03:59:40.3571109+01:00</DueDate>
  <PaymentReference>sample string 33</PaymentReference>
  <CurrencyID>sample string 34</CurrencyID>
  <ExchangeRateDate>2024-11-23T03:59:40.3571109+01:00</ExchangeRateDate>
  <ExchangeRate>1</ExchangeRate>
  <ExchangeRateBase>35</ExchangeRateBase>
  <ExchangeRateID>sample string 36</ExchangeRateID>
  <CurrencyClause>true</CurrencyClause>
  <Document>sample string 37</Document>
  <Comment>sample string 38</Comment>
  <DocumentHeaderDescription>sample string 39</DocumentHeaderDescription>
  <DocumentFooterDescription>sample string 40</DocumentFooterDescription>
  <LanguageID>sample string 41</LanguageID>
  <VATCalculated>sample string 42</VATCalculated>
  <VATInvoiceType>sample string 43</VATInvoiceType>
  <DistanceSale>true</DistanceSale>
  <AssemblingAndInstallation>true</AssemblingAndInstallation>
  <VAT_NonTaxable_Deduction>true</VAT_NonTaxable_Deduction>
  <Status>sample string 44</Status>
  <StatusDate>2024-11-23T03:59:40.3571109+01:00</StatusDate>
  <StatusLines>sample string 45</StatusLines>
  <PriceListID>sample string 46</PriceListID>
  <RebatePercentage>1</RebatePercentage>
  <RebatePercentage2>1</RebatePercentage2>
  <RebatePercentage3>1</RebatePercentage3>
  <RebatePercentage4>1</RebatePercentage4>
  <RebatePercentage5>1</RebatePercentage5>
  <GrossAmout>1</GrossAmout>
  <DiscountAmount>1</DiscountAmount>
  <RebateAmount>1</RebateAmount>
  <NetAmount>1</NetAmount>
  <VATAmount>1</VATAmount>
  <RoundingAmount>1</RoundingAmount>
  <PaymentAmount>1</PaymentAmount>
  <AdvancePaymentAmount>1</AdvancePaymentAmount>
  <VATAdvancePaymentAmount>1</VATAdvancePaymentAmount>
  <RoundingAdvancePaymentAmount>1</RoundingAdvancePaymentAmount>
  <PaymentAdvancePaymentAmount>1</PaymentAdvancePaymentAmount>
  <RebateAmountAmount>1</RebateAmountAmount>
  <InsertedBy>sample string 47</InsertedBy>
  <InsertedTime>2024-11-23T03:59:40.3571109+01:00</InsertedTime>
  <ModifiedBy>sample string 48</ModifiedBy>
  <ModifiedTime>2024-11-23T03:59:40.3571109+01:00</ModifiedTime>
  <CostCenterID>sample string 49</CostCenterID>
  <CostUnitID>sample string 50</CostUnitID>
  <WorkOrderID>sample string 51</WorkOrderID>
  <ClerkID>sample string 52</ClerkID>
  <AnalyticID>sample string 53</AnalyticID>
  <PayerCostCenterID>sample string 54</PayerCostCenterID>
  <AccountingBookGroupID>sample string 55</AccountingBookGroupID>
  <ApplicationName>sample string 56</ApplicationName>
  <LinkToDocument>sample string 57</LinkToDocument>
  <AccountingDescription>sample string 58</AccountingDescription>
  <InstallmentPayment>true</InstallmentPayment>
  <NumberOfInstallmentPayment>59</NumberOfInstallmentPayment>
  <CashTransactionsReference>60</CashTransactionsReference>
  <CashTransactionsID>sample string 61</CashTransactionsID>
  <TaxNumberSecondary>sample string 62</TaxNumberSecondary>
  <CustomerClerkName>sample string 63</CustomerClerkName>
  <CustomerClerkID>sample string 64</CustomerClerkID>
  <DeliveryType>sample string 65</DeliveryType>
  <DeliveryPlace>sample string 66</DeliveryPlace>
  <PaymentCodeID>sample string 67</PaymentCodeID>
  <EnvironmentalTaxAmount>1</EnvironmentalTaxAmount>
  <ParityCode>sample string 68</ParityCode>
  <ParityPlace>sample string 69</ParityPlace>
  <AuthorizationCode>sample string 70</AuthorizationCode>
  <DocumentSalesType>sample string 71</DocumentSalesType>
  <CashOperation>true</CashOperation>
  <CashierID>sample string 72</CashierID>
  <PaymentPurposeId>sample string 73</PaymentPurposeId>
  <Analytic_AN1_ID>sample string 74</Analytic_AN1_ID>
  <Analytic_AN2_ID>sample string 75</Analytic_AN2_ID>
  <Analytic_AN3_ID>sample string 76</Analytic_AN3_ID>
  <DateVD>sample string 77</DateVD>
  <CodeVD>sample string 78</CodeVD>
  <CodeVR>sample string 79</CodeVR>
  <DiscountGroupID>sample string 80</DiscountGroupID>
  <AttachmentID>sample string 81</AttachmentID>
  <AnnexID>sample string 82</AnnexID>
  <FolderID>sample string 83</FolderID>
  <eInvoiceAttachmentID>sample string 84</eInvoiceAttachmentID>
  <DPR_InvoiceNo>sample string 85</DPR_InvoiceNo>
  <PaymentReferenceExternal>sample string 86</PaymentReferenceExternal>
  <ContactPerson>sample string 87</ContactPerson>
  <InstallmentsPayment>true</InstallmentsPayment>
  <NumberOfInstallments>88</NumberOfInstallments>
  <InvoiceID>sample string 89</InvoiceID>
  <VATTaxCategory>sample string 90</VATTaxCategory>
  <FiscalizationDate>sample string 91</FiscalizationDate>
  <UniqueInvoiceID>sample string 92</UniqueInvoiceID>
  <SecurityCodeOfInvoice>sample string 93</SecurityCodeOfInvoice>
  <LocationID>sample string 94</LocationID>
  <DeliveryLocationAddress>sample string 95</DeliveryLocationAddress>
  <ContactTypeID>sample string 96</ContactTypeID>
  <ContactInTypeID>97</ContactInTypeID>
  <InvoiceLines>
    <InvoiceLine>
      <LineNumber>1</LineNumber>
      <ItemID>sample string 2</ItemID>
      <ItemIDType>sample string 3</ItemIDType>
      <ItemCode>sample string 4</ItemCode>
      <ItemEAN>sample string 5</ItemEAN>
      <AlternateUnitOfMeasurment>sample string 6</AlternateUnitOfMeasurment>
      <AlternateConvertFactor>1</AlternateConvertFactor>
      <AlternateQuantity>1</AlternateQuantity>
      <AlternateEAN>sample string 7</AlternateEAN>
      <Series>sample string 8</Series>
      <ItemTitle1>sample string 9</ItemTitle1>
      <ItemTitle2>sample string 10</ItemTitle2>
      <UnitOfMeasurement>sample string 11</UnitOfMeasurement>
      <ItemDescription>sample string 12</ItemDescription>
      <VATRateID>sample string 13</VATRateID>
      <VATRatePercent>1</VATRatePercent>
      <Note>sample string 14</Note>
      <Quantity>1</Quantity>
      <QuantityAdditionalUOM>1</QuantityAdditionalUOM>
      <Price>1</Price>
      <PriceWithVAT>1</PriceWithVAT>
      <UnitsForprice>15</UnitsForprice>
      <DiscountPercentage>1</DiscountPercentage>
      <DiscountPercentage2>1</DiscountPercentage2>
      <DiscountPercentage3>1</DiscountPercentage3>
      <DiscountPercentage4>1</DiscountPercentage4>
      <DiscountPercentage5>1</DiscountPercentage5>
      <DiscountAmount>1</DiscountAmount>
      <DiscountAmountAmount>1</DiscountAmountAmount>
      <RebateAmount>1</RebateAmount>
      <RebateAmountAmount>1</RebateAmountAmount>
      <VATAmount>1</VATAmount>
      <GrossAmout>1</GrossAmout>
      <IntermediateAmount>1</IntermediateAmount>
      <NetAmount>1</NetAmount>
      <CostCenterID>sample string 16</CostCenterID>
      <CostUnitID>sample string 17</CostUnitID>
      <WorkOrderID>sample string 18</WorkOrderID>
      <ClerkID>sample string 19</ClerkID>
      <AnalyticID>sample string 20</AnalyticID>
      <Analytic_AN1_ID>sample string 21</Analytic_AN1_ID>
      <Analytic_AN2_ID>sample string 22</Analytic_AN2_ID>
      <Analytic_AN3_ID>sample string 23</Analytic_AN3_ID>
      <PayerCostCenterID>sample string 24</PayerCostCenterID>
      <VATCalculated>sample string 25</VATCalculated>
      <VATRateDescription>sample string 26</VATRateDescription>
      <VATInvoiceType>sample string 27</VATInvoiceType>
      <Reference>sample string 28</Reference>
      <TextLine>true</TextLine>
      <EnvironmentalTaxAmount>1</EnvironmentalTaxAmount>
      <EnvironmentalTaxAmount2>1</EnvironmentalTaxAmount2>
      <InsertedBy>sample string 29</InsertedBy>
      <InsertedTime>2024-11-23T03:59:40.3727369+01:00</InsertedTime>
      <ModifiedBy>sample string 30</ModifiedBy>
      <ModifiedTime>2024-11-23T03:59:40.3727369+01:00</ModifiedTime>
      <PriceIncludeVAT>true</PriceIncludeVAT>
      <RealizationAccount>sample string 31</RealizationAccount>
      <RebateAccount>sample string 32</RebateAccount>
      <VATTaxCategory>sample string 33</VATTaxCategory>
    </InvoiceLine>
    <InvoiceLine>
      <LineNumber>1</LineNumber>
      <ItemID>sample string 2</ItemID>
      <ItemIDType>sample string 3</ItemIDType>
      <ItemCode>sample string 4</ItemCode>
      <ItemEAN>sample string 5</ItemEAN>
      <AlternateUnitOfMeasurment>sample string 6</AlternateUnitOfMeasurment>
      <AlternateConvertFactor>1</AlternateConvertFactor>
      <AlternateQuantity>1</AlternateQuantity>
      <AlternateEAN>sample string 7</AlternateEAN>
      <Series>sample string 8</Series>
      <ItemTitle1>sample string 9</ItemTitle1>
      <ItemTitle2>sample string 10</ItemTitle2>
      <UnitOfMeasurement>sample string 11</UnitOfMeasurement>
      <ItemDescription>sample string 12</ItemDescription>
      <VATRateID>sample string 13</VATRateID>
      <VATRatePercent>1</VATRatePercent>
      <Note>sample string 14</Note>
      <Quantity>1</Quantity>
      <QuantityAdditionalUOM>1</QuantityAdditionalUOM>
      <Price>1</Price>
      <PriceWithVAT>1</PriceWithVAT>
      <UnitsForprice>15</UnitsForprice>
      <DiscountPercentage>1</DiscountPercentage>
      <DiscountPercentage2>1</DiscountPercentage2>
      <DiscountPercentage3>1</DiscountPercentage3>
      <DiscountPercentage4>1</DiscountPercentage4>
      <DiscountPercentage5>1</DiscountPercentage5>
      <DiscountAmount>1</DiscountAmount>
      <DiscountAmountAmount>1</DiscountAmountAmount>
      <RebateAmount>1</RebateAmount>
      <RebateAmountAmount>1</RebateAmountAmount>
      <VATAmount>1</VATAmount>
      <GrossAmout>1</GrossAmout>
      <IntermediateAmount>1</IntermediateAmount>
      <NetAmount>1</NetAmount>
      <CostCenterID>sample string 16</CostCenterID>
      <CostUnitID>sample string 17</CostUnitID>
      <WorkOrderID>sample string 18</WorkOrderID>
      <ClerkID>sample string 19</ClerkID>
      <AnalyticID>sample string 20</AnalyticID>
      <Analytic_AN1_ID>sample string 21</Analytic_AN1_ID>
      <Analytic_AN2_ID>sample string 22</Analytic_AN2_ID>
      <Analytic_AN3_ID>sample string 23</Analytic_AN3_ID>
      <PayerCostCenterID>sample string 24</PayerCostCenterID>
      <VATCalculated>sample string 25</VATCalculated>
      <VATRateDescription>sample string 26</VATRateDescription>
      <VATInvoiceType>sample string 27</VATInvoiceType>
      <Reference>sample string 28</Reference>
      <TextLine>true</TextLine>
      <EnvironmentalTaxAmount>1</EnvironmentalTaxAmount>
      <EnvironmentalTaxAmount2>1</EnvironmentalTaxAmount2>
      <InsertedBy>sample string 29</InsertedBy>
      <InsertedTime>2024-11-23T03:59:40.3727369+01:00</InsertedTime>
      <ModifiedBy>sample string 30</ModifiedBy>
      <ModifiedTime>2024-11-23T03:59:40.3727369+01:00</ModifiedTime>
      <PriceIncludeVAT>true</PriceIncludeVAT>
      <RealizationAccount>sample string 31</RealizationAccount>
      <RebateAccount>sample string 32</RebateAccount>
      <VATTaxCategory>sample string 33</VATTaxCategory>
    </InvoiceLine>
  </InvoiceLines>
  <InvoiceInstallments>
    <InvoiceInstallment>
      <InstallmentNumber>1</InstallmentNumber>
      <InstallmentDueDate>2024-11-23T03:59:40.3727369+01:00</InstallmentDueDate>
      <InstallmentAmount>1</InstallmentAmount>
      <InstallmentReference>sample string 2</InstallmentReference>
      <InstallmentAccountID>sample string 3</InstallmentAccountID>
      <InsertedBy>sample string 4</InsertedBy>
      <InsertionTime>2024-11-23T03:59:40.3727369+01:00</InsertionTime>
      <ModifiedBy>sample string 5</ModifiedBy>
      <ModificationTime>2024-11-23T03:59:40.3727369+01:00</ModificationTime>
    </InvoiceInstallment>
    <InvoiceInstallment>
      <InstallmentNumber>1</InstallmentNumber>
      <InstallmentDueDate>2024-11-23T03:59:40.3727369+01:00</InstallmentDueDate>
      <InstallmentAmount>1</InstallmentAmount>
      <InstallmentReference>sample string 2</InstallmentReference>
      <InstallmentAccountID>sample string 3</InstallmentAccountID>
      <InsertedBy>sample string 4</InsertedBy>
      <InsertionTime>2024-11-23T03:59:40.3727369+01:00</InsertionTime>
      <ModifiedBy>sample string 5</ModifiedBy>
      <ModificationTime>2024-11-23T03:59:40.3727369+01:00</ModificationTime>
    </InvoiceInstallment>
  </InvoiceInstallments>
  <InvoiceAdvancePayments>
    <InvoiceAdvancePayment>
      <AdvancePaymentID>sample string 1</AdvancePaymentID>
      <SrcApplication>sample string 2</SrcApplication>
      <SrcKey>sample string 3</SrcKey>
      <AmountLC>1</AmountLC>
      <Amount>1</Amount>
      <ExchangeRate>1</ExchangeRate>
      <InsertedBy>sample string 4</InsertedBy>
      <InsertionTime>2024-11-23T03:59:40.3727369+01:00</InsertionTime>
      <ModifiedBy>sample string 5</ModifiedBy>
      <ModificationTime>2024-11-23T03:59:40.3727369+01:00</ModificationTime>
    </InvoiceAdvancePayment>
    <InvoiceAdvancePayment>
      <AdvancePaymentID>sample string 1</AdvancePaymentID>
      <SrcApplication>sample string 2</SrcApplication>
      <SrcKey>sample string 3</SrcKey>
      <AmountLC>1</AmountLC>
      <Amount>1</Amount>
      <ExchangeRate>1</ExchangeRate>
      <InsertedBy>sample string 4</InsertedBy>
      <InsertionTime>2024-11-23T03:59:40.3727369+01:00</InsertionTime>
      <ModifiedBy>sample string 5</ModifiedBy>
      <ModificationTime>2024-11-23T03:59:40.3727369+01:00</ModificationTime>
    </InvoiceAdvancePayment>
  </InvoiceAdvancePayments>
  <InvoicePayments>
    <InvoicePayment>
      <PaymentLineNo>1</PaymentLineNo>
      <PaymentPurposeID>sample string 2</PaymentPurposeID>
      <PaymentAmount>1</PaymentAmount>
      <PaymentDate>2024-11-23T03:59:40.3727369+01:00</PaymentDate>
      <PaymentTransactionID>sample string 3</PaymentTransactionID>
    </InvoicePayment>
    <InvoicePayment>
      <PaymentLineNo>1</PaymentLineNo>
      <PaymentPurposeID>sample string 2</PaymentPurposeID>
      <PaymentAmount>1</PaymentAmount>
      <PaymentDate>2024-11-23T03:59:40.3727369+01:00</PaymentDate>
      <PaymentTransactionID>sample string 3</PaymentTransactionID>
    </InvoicePayment>
  </InvoicePayments>
</InvoiceHeader>