GET v2.0/ProformaInvoices/{id}

Request Information

Returns information about a proforma invoice, including summaries.

Example URL:
 v2.0/ProformaInvoices/{id}

URL parameters
Body parameters

Name	Description	Type	Additional information
id	Invoice Id	integer	Required
id	Invoice Id	integer	Required

None.

Response Information

Resource Description
Response Formats

ProformaInvoiceApiModel

Name	Description	Type	Additional information
AttachmentFileName	Name of the attached file. If no attachment is included, this will be empty.	string	None.
BaseTaxBasicRate	Tax base - basic rate	decimal number	None.
BaseTaxBasicRateHc	Tax base - basic rate in home currency	decimal number	None.
BaseTaxReducedRate1	Tax base - Reduce rate 1	decimal number	None.
BaseTaxReducedRate1Hc	Tax base - Reduce rate 1 in home currency	decimal number	None.
BaseTaxReducedRate2	Tax base - Reduce rate 2	decimal number	None.
BaseTaxReducedRate2Hc	Tax base - Reduce rate 2 in home currency	decimal number	None.
BaseTaxZeroRate	Tax base - Zero rate	decimal number	None.
BaseTaxZeroRateHc	Tax base - Zero rate in home currency	decimal number	None.
ConstantSymbolId	Constant symbol Id	integer	None.
CurrencyId	Currency Id	integer	None.
DateLastChange	Date last change	date	None.
DateOfAccountingEvent	Date of accounting event	date	None.
DateOfIssue	Date of issue	date	None.
DateOfLastReminder	Date of last reminder	date	None.
DateOfMaturity	Date of maturity	date	None.
DateOfPayment	Date of payment	date	None.
Description	Description	string	None.
DocumentNumber	DocumentNumber	string	Length: between 0 and 10 inclusive
DocumentSerialNumber	Document Serial Number	integer	None.
EetResponsibility	Responsibility for handlig of electronic records of sales.	EetResponsibility	None.
ExchangeRate	Exchange rate	decimal number	None.
ExchangeRateAmount	Exchange rate amount	decimal number	None.
Exported	Export to another accounting software indication. (It is recommended to use only one external accounting software beside iDoklad.)	ExportedState	None.
Id	Resource identifier	integer	Readonly
IsEet	Flag indicating whether the sales receipt is registered in EET.	boolean	None.
IsIncomeTax	Include subject to income tax	boolean	Used in Cz legislation.
IsProformaTaxed		boolean	None.
IsSentToAccountant	Indicate sending to accountant	boolean	None.
IsSentToPurchaser	Indicate sending to purchaser	boolean	None.
ItemsTextPrefix	Items text prefix	string	None.
ItemsTextSuffix	Items text suffix	string	None.
LanguageCode	Culture code of the invoice language.	string	None.
LanguageId	Report language Id	integer	Use LanguageCode.
Maturity	Maturity in days	integer	None.
MyCompanyDocumentAdrressId	My company document address Id	integer	None.
Note	Note	string	None.
OrderNumber	Order number	string	Length: between 0 and 20 inclusive
PaymentOptionId		integer	None.
PaymentStatus		PaymentStatus	None.
ProformaInvoiceItems		Collection of IssuedInvoiceItemApiModel	None.
PurchaserDocumentAddressId		integer	None.
PurchaserId		integer	None.
RecountVersion		RecountVersion	None.
RemindersCount		integer	None.
ReportColorValue	Report color in html color format	string	None.
ReportId		integer	None.
RoundingDifference		decimal number	None.
TaxBasicRate		decimal number	None.
TaxBasicRateHc		decimal number	None.
TaxReducedRate1		decimal number	None.
TaxReducedRate1Hc		decimal number	None.
TaxReducedRate2		decimal number	None.
TaxReducedRate2Hc		decimal number	None.
TotalBasicRate		decimal number	None.
TotalBasicRateHc		decimal number	None.
TotalReducedRate1		decimal number	None.
TotalReducedRate1Hc		decimal number	None.
TotalReducedRate2		decimal number	None.
TotalReducedRate2Hc		decimal number	None.
TotalVat		decimal number	None.
TotalVatHc		decimal number	None.
TotalWithoutVat		decimal number	None.
TotalWithoutVatHc		decimal number	None.
TotalWithVat		decimal number	None.
TotalWithVatHc		decimal number	None.
VariableSymbol		string	Length: between 0 and 10 inclusive
VatOnPayStatus	Attribute for application of VAT based on payments	VatOnPayStatus	Used in Sk legislation.
VatRateBasic		decimal number	None.
VatRateReduced1		decimal number	None.
VatRateReduced2		decimal number	None.
VatRegime	VAT regime	VatRegime	None.

application/json, text/json
application/xml, text/xml

Sample:

{
  "AttachmentFileName": "sample string 1",
  "BaseTaxBasicRate": 2.0,
  "BaseTaxBasicRateHc": 3.0,
  "BaseTaxReducedRate1": 4.0,
  "BaseTaxReducedRate1Hc": 5.0,
  "BaseTaxReducedRate2": 6.0,
  "BaseTaxReducedRate2Hc": 7.0,
  "BaseTaxZeroRate": 8.0,
  "BaseTaxZeroRateHc": 9.0,
  "ConstantSymbolId": 10,
  "CurrencyId": 11,
  "DateLastChange": "2024-11-02T05:24:53.1779047+00:00",
  "DateOfAccountingEvent": "2024-11-02T05:24:53.1779047+00:00",
  "DateOfIssue": "2024-11-02T05:24:53.1779047+00:00",
  "DateOfLastReminder": "2024-11-02T05:24:53.1779047+00:00",
  "DateOfMaturity": "2024-11-02T05:24:53.1779047+00:00",
  "DateOfPayment": "2024-11-02T05:24:53.1779047+00:00",
  "Description": "sample string 18",
  "DocumentNumber": "sample string 19",
  "DocumentSerialNumber": 20,
  "EetResponsibility": 0,
  "ExchangeRate": 21.0,
  "ExchangeRateAmount": 22.0,
  "Exported": 0,
  "IsEet": true,
  "IsProformaTaxed": true,
  "IsSentToAccountant": true,
  "IsSentToPurchaser": true,
  "ItemsTextPrefix": "sample string 27",
  "ItemsTextSuffix": "sample string 28",
  "LanguageCode": "sample string 29",
  "LanguageId": 30,
  "Maturity": 31,
  "MyCompanyDocumentAdrressId": 32,
  "Note": "sample string 33",
  "OrderNumber": "sample string 34",
  "PaymentOptionId": 35,
  "PaymentStatus": 0,
  "ProformaInvoiceItems": [
    {
      "InvoiceId": 1,
      "TotalWithVatBeforeDiscount": 2.0,
      "TotalWithoutVatBeforeDiscount": 3.0,
      "TotalVatBeforeDiscount": 4.0,
      "Code": "sample string 5",
      "DateLastChange": "2024-11-02T05:24:53.1779047+00:00",
      "IsRoundedItem": true,
      "IsTaxMovement": true,
      "ItemType": 0,
      "Price": 9.0,
      "PriceTotalWithoutVat": 10.0,
      "PriceTotalWithoutVatHc": 11.0,
      "PriceTotalWithVat": 12.0,
      "PriceTotalWithVatHc": 13.0,
      "PriceUnitVat": 14.0,
      "PriceUnitVatHc": 15.0,
      "PriceUnitWithoutVat": 16.0,
      "PriceUnitWithoutVatHc": 17.0,
      "PriceUnitWithVat": 18.0,
      "PriceUnitWithVatHc": 19.0,
      "TotalPrice": 20.0,
      "VatRate": 21.0,
      "VatTotal": 22.0,
      "VatTotalHc": 23.0,
      "Amount": 24.0,
      "Name": "sample string 25",
      "PriceListItemId": 1,
      "PriceType": 0,
      "Unit": "sample string 26",
      "UnitPrice": 27.0,
      "VatCodeId": 1,
      "VatRateType": 0,
      "Id": 28
    }
  ],
  "PurchaserDocumentAddressId": 36,
  "PurchaserId": 37,
  "RemindersCount": 38,
  "ReportColorValue": "sample string 39",
  "ReportId": 40,
  "RoundingDifference": 41.0,
  "TaxBasicRate": 42.0,
  "TaxBasicRateHc": 43.0,
  "TaxReducedRate1": 44.0,
  "TaxReducedRate1Hc": 45.0,
  "TaxReducedRate2": 46.0,
  "TaxReducedRate2Hc": 47.0,
  "TotalBasicRate": 48.0,
  "TotalBasicRateHc": 49.0,
  "TotalReducedRate1": 50.0,
  "TotalReducedRate1Hc": 51.0,
  "TotalReducedRate2": 52.0,
  "TotalReducedRate2Hc": 53.0,
  "TotalVat": 54.0,
  "TotalVatHc": 55.0,
  "TotalWithoutVat": 56.0,
  "TotalWithoutVatHc": 57.0,
  "TotalWithVat": 58.0,
  "TotalWithVatHc": 59.0,
  "VariableSymbol": "sample string 60",
  "VatOnPayStatus": 0,
  "VatRegime": 0,
  "VatRateBasic": 61.0,
  "VatRateReduced1": 62.0,
  "VatRateReduced2": 63.0,
  "IsIncomeTax": true,
  "RecountVersion": 0,
  "Id": 65
}

Sample:

<ProformaInvoiceApiModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Doklad.Api.ApiModels.ProformaInvoice">
  <Id xmlns="http://schemas.datacontract.org/2004/07/Doklad.Api.ApiModels.BaseModels">65</Id>
  <Links xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/Doklad.Api.ApiModels.BaseModels">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Links>
  <AttachmentFileName>sample string 1</AttachmentFileName>
  <BaseTaxBasicRate>2</BaseTaxBasicRate>
  <BaseTaxBasicRateHc>3</BaseTaxBasicRateHc>
  <BaseTaxReducedRate1>4</BaseTaxReducedRate1>
  <BaseTaxReducedRate1Hc>5</BaseTaxReducedRate1Hc>
  <BaseTaxReducedRate2>6</BaseTaxReducedRate2>
  <BaseTaxReducedRate2Hc>7</BaseTaxReducedRate2Hc>
  <BaseTaxZeroRate>8</BaseTaxZeroRate>
  <BaseTaxZeroRateHc>9</BaseTaxZeroRateHc>
  <ConstantSymbolId>10</ConstantSymbolId>
  <CurrencyId>11</CurrencyId>
  <DateLastChange>2024-11-02T05:24:53.1779047+00:00</DateLastChange>
  <DateOfAccountingEvent>2024-11-02T05:24:53.1779047+00:00</DateOfAccountingEvent>
  <DateOfIssue>2024-11-02T05:24:53.1779047+00:00</DateOfIssue>
  <DateOfLastReminder>2024-11-02T05:24:53.1779047+00:00</DateOfLastReminder>
  <DateOfMaturity>2024-11-02T05:24:53.1779047+00:00</DateOfMaturity>
  <DateOfPayment>2024-11-02T05:24:53.1779047+00:00</DateOfPayment>
  <Description>sample string 18</Description>
  <DocumentNumber>sample string 19</DocumentNumber>
  <DocumentSerialNumber>20</DocumentSerialNumber>
  <EetResponsibility>Idoklad</EetResponsibility>
  <ExchangeRate>21</ExchangeRate>
  <ExchangeRateAmount>22</ExchangeRateAmount>
  <Exported>0</Exported>
  <IsEet>true</IsEet>
  <IsIncomeTax>true</IsIncomeTax>
  <IsProformaTaxed>true</IsProformaTaxed>
  <IsSentToAccountant>true</IsSentToAccountant>
  <IsSentToPurchaser>true</IsSentToPurchaser>
  <ItemsTextPrefix>sample string 27</ItemsTextPrefix>
  <ItemsTextSuffix>sample string 28</ItemsTextSuffix>
  <LanguageCode>sample string 29</LanguageCode>
  <LanguageId>30</LanguageId>
  <Maturity>31</Maturity>
  <MyCompanyDocumentAdrressId>32</MyCompanyDocumentAdrressId>
  <Note>sample string 33</Note>
  <OrderNumber>sample string 34</OrderNumber>
  <PaymentOptionId>35</PaymentOptionId>
  <PaymentStatus>0</PaymentStatus>
  <ProformaInvoiceItems xmlns:d2p1="http://schemas.datacontract.org/2004/07/Doklad.Api.ApiModels">
    <d2p1:IssuedInvoiceItemApiModel>
      <Id xmlns="http://schemas.datacontract.org/2004/07/Doklad.Api.ApiModels.BaseModels">28</Id>
      <Links xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/Doklad.Api.ApiModels.BaseModels">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>sample string 1</d4p1:Key>
          <d4p1:Value>sample string 2</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </Links>
      <d2p1:Amount>24</d2p1:Amount>
      <d2p1:Name>sample string 25</d2p1:Name>
      <d2p1:PriceListItemId>1</d2p1:PriceListItemId>
      <d2p1:PriceType>0</d2p1:PriceType>
      <d2p1:Unit>sample string 26</d2p1:Unit>
      <d2p1:UnitPrice>27</d2p1:UnitPrice>
      <d2p1:VatCodeId>1</d2p1:VatCodeId>
      <d2p1:VatRateType>0</d2p1:VatRateType>
      <d2p1:Code>sample string 5</d2p1:Code>
      <d2p1:DateLastChange>2024-11-02T05:24:53.1779047+00:00</d2p1:DateLastChange>
      <d2p1:IsRoundedItem>true</d2p1:IsRoundedItem>
      <d2p1:IsTaxMovement>true</d2p1:IsTaxMovement>
      <d2p1:ItemType>0</d2p1:ItemType>
      <d2p1:Price>9</d2p1:Price>
      <d2p1:PriceTotalWithVat>12</d2p1:PriceTotalWithVat>
      <d2p1:PriceTotalWithVatHc>13</d2p1:PriceTotalWithVatHc>
      <d2p1:PriceTotalWithoutVat>10</d2p1:PriceTotalWithoutVat>
      <d2p1:PriceTotalWithoutVatHc>11</d2p1:PriceTotalWithoutVatHc>
      <d2p1:PriceUnitVat>14</d2p1:PriceUnitVat>
      <d2p1:PriceUnitVatHc>15</d2p1:PriceUnitVatHc>
      <d2p1:PriceUnitWithVat>18</d2p1:PriceUnitWithVat>
      <d2p1:PriceUnitWithVatHc>19</d2p1:PriceUnitWithVatHc>
      <d2p1:PriceUnitWithoutVat>16</d2p1:PriceUnitWithoutVat>
      <d2p1:PriceUnitWithoutVatHc>17</d2p1:PriceUnitWithoutVatHc>
      <d2p1:TotalPrice>20</d2p1:TotalPrice>
      <d2p1:VatRate>21</d2p1:VatRate>
      <d2p1:VatTotal>22</d2p1:VatTotal>
      <d2p1:VatTotalHc>23</d2p1:VatTotalHc>
      <d2p1:InvoiceId>1</d2p1:InvoiceId>
      <d2p1:TotalVatBeforeDiscount>4</d2p1:TotalVatBeforeDiscount>
      <d2p1:TotalWithVatBeforeDiscount>2</d2p1:TotalWithVatBeforeDiscount>
      <d2p1:TotalWithoutVatBeforeDiscount>3</d2p1:TotalWithoutVatBeforeDiscount>
    </d2p1:IssuedInvoiceItemApiModel>
  </ProformaInvoiceItems>
  <PurchaserDocumentAddressId>36</PurchaserDocumentAddressId>
  <PurchaserId>37</PurchaserId>
  <RecountVersion>None</RecountVersion>
  <RemindersCount>38</RemindersCount>
  <ReportColorValue>sample string 39</ReportColorValue>
  <ReportId>40</ReportId>
  <RoundingDifference>41</RoundingDifference>
  <TaxBasicRate>42</TaxBasicRate>
  <TaxBasicRateHc>43</TaxBasicRateHc>
  <TaxReducedRate1>44</TaxReducedRate1>
  <TaxReducedRate1Hc>45</TaxReducedRate1Hc>
  <TaxReducedRate2>46</TaxReducedRate2>
  <TaxReducedRate2Hc>47</TaxReducedRate2Hc>
  <TotalBasicRate>48</TotalBasicRate>
  <TotalBasicRateHc>49</TotalBasicRateHc>
  <TotalReducedRate1>50</TotalReducedRate1>
  <TotalReducedRate1Hc>51</TotalReducedRate1Hc>
  <TotalReducedRate2>52</TotalReducedRate2>
  <TotalReducedRate2Hc>53</TotalReducedRate2Hc>
  <TotalVat>54</TotalVat>
  <TotalVatHc>55</TotalVatHc>
  <TotalWithVat>58</TotalWithVat>
  <TotalWithVatHc>59</TotalWithVatHc>
  <TotalWithoutVat>56</TotalWithoutVat>
  <TotalWithoutVatHc>57</TotalWithoutVatHc>
  <VariableSymbol>sample string 60</VariableSymbol>
  <VatOnPayStatus>0</VatOnPayStatus>
  <VatRateBasic>61</VatRateBasic>
  <VatRateReduced1>62</VatRateReduced1>
  <VatRateReduced2>63</VatRateReduced2>
  <VatRegime>NonVatRegime</VatRegime>
</ProformaInvoiceApiModel>