Request Information

Updates received invoice by Id.

Example URL:
v2.0/ReceivedInvoices/{id}
NameDescriptionTypeAdditional information
id

Invoice Id

integer

Required

id

Invoice Id

integer

Required

Invoice entity or properties for update

ReceivedInvoicePatchModelV2
NameDescriptionTypeAdditional information
AccountNumber

string

Length: between 0 and 50 inclusive

BankId

integer

None.

BankNumberCode

string

Length: between 0 and 4 inclusive

CurrencyId

integer

None.

DateOfIssue

date

None.

DateOfMaturity

date

None.

DateOfPayment

date

None.

DateOfReceiving

date

None.

DateOfTaxing

date

None.

DateOfVatApplication

Date of VAT application

date

Used in Sk legislation.

Description

string

None.

DocumentNumber

string

Readonly

DocumentSerialNumber

integer

None.

ExchangeRate

decimal number

None.

ExchangeRateAmount

decimal number

None.

Iban

Iban of the supplier

string

Length: between 0 and 50 inclusive

IsIncomeTax

Include subject to income tax

boolean

Used in Cz legislation.

Note

string

None.

OrderNumber

string

Length: between 0 and 20 inclusive

PaymentOptionId

integer

None.

ReceivedDocumentNumber

Document number of the original document

string

Length: between 0 and 30 inclusive

ReceivedInvoiceItems

Collection of ReceivedInvoiceItemApiModelUpdate

None.

SupplierId

integer

None.

Swift

Swift of the supplier

string

Length: between 0 and 11 inclusive

VariableSymbol

string

Length: between 0 and 10 inclusive

VatOnPayStatus

Attribute for application of VAT based on payments

VatOnPayStatus

Used in Sk legislation.

VatReverseChargeCodeId

Vat reverse charge code id

integer

Used in Cz legislation.

Sample:
{
  "VatReverseChargeCodeId": 1,
  "IsIncomeTax": true,
  "AccountNumber": "sample string 1",
  "BankId": 1,
  "BankNumberCode": "sample string 2",
  "CurrencyId": 1,
  "DateOfIssue": "2021-05-09T01:28:40.6942843+00:00",
  "DateOfMaturity": "2021-05-09T01:28:40.6942843+00:00",
  "DateOfPayment": "2021-05-09T01:28:40.6942843+00:00",
  "DateOfReceiving": "2021-05-09T01:28:40.6942843+00:00",
  "DateOfTaxing": "2021-05-09T01:28:40.6942843+00:00",
  "Description": "sample string 3",
  "DocumentSerialNumber": 1,
  "DocumentNumber": "sample string 4",
  "ExchangeRate": 1.0,
  "ExchangeRateAmount": 1.0,
  "Iban": "sample string 5",
  "Note": "sample string 6",
  "OrderNumber": "sample string 7",
  "PaymentOptionId": 1,
  "ReceivedDocumentNumber": "sample string 8",
  "ReceivedInvoiceItems": [
    {
      "Amount": 1.0,
      "CustomVatRate": 1.0,
      "Name": "sample string 1",
      "PriceListItemId": 1,
      "PriceType": 0,
      "Unit": "sample string 2",
      "UnitPrice": 1.0,
      "VatCodeId": 1,
      "VatRateType": 0,
      "Id": 3
    }
  ],
  "SupplierId": 1,
  "Swift": "sample string 9",
  "VariableSymbol": "sample string 10",
  "VatOnPayStatus": 0,
  "DateOfVatApplication": "2021-05-09T01:28:40.6942843+00:00"
}
Sample:
<ReceivedInvoicePatchModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Doklad.Api.ApiModels.PatchModels">
  <AccountNumber xmlns="http://schemas.datacontract.org/2004/07/Doklad.Api.ApiModels.ReceivedInvoice">sample string 1</AccountNumber>
  <BankId xmlns="http://schemas.datacontract.org/2004/07/Doklad.Api.ApiModels.ReceivedInvoice">1</BankId>
  <BankNumberCode xmlns="http://schemas.datacontract.org/2004/07/Doklad.Api.ApiModels.ReceivedInvoice">sample string 2</BankNumberCode>
  <CurrencyId xmlns="http://schemas.datacontract.org/2004/07/Doklad.Api.ApiModels.ReceivedInvoice">1</CurrencyId>
  <DateOfIssue xmlns="http://schemas.datacontract.org/2004/07/Doklad.Api.ApiModels.ReceivedInvoice">2021-05-09T01:28:40.6942843+00:00</DateOfIssue>
  <DateOfMaturity xmlns="http://schemas.datacontract.org/2004/07/Doklad.Api.ApiModels.ReceivedInvoice">2021-05-09T01:28:40.6942843+00:00</DateOfMaturity>
  <DateOfPayment xmlns="http://schemas.datacontract.org/2004/07/Doklad.Api.ApiModels.ReceivedInvoice">2021-05-09T01:28:40.6942843+00:00</DateOfPayment>
  <DateOfReceiving xmlns="http://schemas.datacontract.org/2004/07/Doklad.Api.ApiModels.ReceivedInvoice">2021-05-09T01:28:40.6942843+00:00</DateOfReceiving>
  <DateOfTaxing xmlns="http://schemas.datacontract.org/2004/07/Doklad.Api.ApiModels.ReceivedInvoice">2021-05-09T01:28:40.6942843+00:00</DateOfTaxing>
  <DateOfVatApplication xmlns="http://schemas.datacontract.org/2004/07/Doklad.Api.ApiModels.ReceivedInvoice">2021-05-09T01:28:40.6942843+00:00</DateOfVatApplication>
  <Description xmlns="http://schemas.datacontract.org/2004/07/Doklad.Api.ApiModels.ReceivedInvoice">sample string 3</Description>
  <DocumentNumber xmlns="http://schemas.datacontract.org/2004/07/Doklad.Api.ApiModels.ReceivedInvoice">sample string 4</DocumentNumber>
  <DocumentSerialNumber xmlns="http://schemas.datacontract.org/2004/07/Doklad.Api.ApiModels.ReceivedInvoice">1</DocumentSerialNumber>
  <ExchangeRate xmlns="http://schemas.datacontract.org/2004/07/Doklad.Api.ApiModels.ReceivedInvoice">1</ExchangeRate>
  <ExchangeRateAmount xmlns="http://schemas.datacontract.org/2004/07/Doklad.Api.ApiModels.ReceivedInvoice">1</ExchangeRateAmount>
  <Iban xmlns="http://schemas.datacontract.org/2004/07/Doklad.Api.ApiModels.ReceivedInvoice">sample string 5</Iban>
  <Note xmlns="http://schemas.datacontract.org/2004/07/Doklad.Api.ApiModels.ReceivedInvoice">sample string 6</Note>
  <OrderNumber xmlns="http://schemas.datacontract.org/2004/07/Doklad.Api.ApiModels.ReceivedInvoice">sample string 7</OrderNumber>
  <PaymentOptionId xmlns="http://schemas.datacontract.org/2004/07/Doklad.Api.ApiModels.ReceivedInvoice">1</PaymentOptionId>
  <ReceivedDocumentNumber xmlns="http://schemas.datacontract.org/2004/07/Doklad.Api.ApiModels.ReceivedInvoice">sample string 8</ReceivedDocumentNumber>
  <ReceivedInvoiceItems xmlns="http://schemas.datacontract.org/2004/07/Doklad.Api.ApiModels.ReceivedInvoice">
    <ReceivedInvoiceItemApiModelUpdate>
      <Id xmlns="http://schemas.datacontract.org/2004/07/Doklad.Api.ApiModels.BaseModels">3</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>
      <Amount>1</Amount>
      <CustomVatRate>1</CustomVatRate>
      <Name>sample string 1</Name>
      <PriceListItemId>1</PriceListItemId>
      <PriceType>0</PriceType>
      <Unit>sample string 2</Unit>
      <UnitPrice>1</UnitPrice>
      <VatCodeId>1</VatCodeId>
      <VatRateType>0</VatRateType>
    </ReceivedInvoiceItemApiModelUpdate>
  </ReceivedInvoiceItems>
  <SupplierId xmlns="http://schemas.datacontract.org/2004/07/Doklad.Api.ApiModels.ReceivedInvoice">1</SupplierId>
  <Swift xmlns="http://schemas.datacontract.org/2004/07/Doklad.Api.ApiModels.ReceivedInvoice">sample string 9</Swift>
  <VariableSymbol xmlns="http://schemas.datacontract.org/2004/07/Doklad.Api.ApiModels.ReceivedInvoice">sample string 10</VariableSymbol>
  <VatOnPayStatus xmlns="http://schemas.datacontract.org/2004/07/Doklad.Api.ApiModels.ReceivedInvoice">0</VatOnPayStatus>
  <IsIncomeTax>true</IsIncomeTax>
  <VatReverseChargeCodeId>1</VatReverseChargeCodeId>
</ReceivedInvoicePatchModel>

Response Information

ReceivedInvoiceApiModel
NameDescriptionTypeAdditional information
AttachmentFileName

Name of the attached file. If no attachment is included, this will be empty.

string

None.

CurrencyId

integer

None.

DateCreated

date

None.

DateLastChange

date

None.

DateOfAccountingEvent

date

None.

DateOfIssue

date

None.

DateOfMaturity

date

None.

DateOfPayment

date

None.

DateOfReceiving

date

None.

DateOfTaxing

date

None.

DateOfVatApplication

Date of VAT application

date

Used in Sk legislation.

Description

string

None.

DocumentNumber

string

Length: between 0 and 10 inclusive

DocumentSerialNumber

integer

None.

ExchangeRate

decimal number

None.

ExchangeRateAmount

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

IsIncomeTax

Include subject to income tax

boolean

Used in Cz legislation.

IsSentToAccountant

boolean

None.

Items

Collection of ReceivedInvoiceItemApiModel

None.

MyCompanyDocumentAddressId

integer

None.

Note

string

None.

OrderNumber

string

Length: between 0 and 20 inclusive

PaymentOptionId

integer

None.

PaymentStatus

PaymentStatus

None.

ReceivedDocumentNumber

Document number of the original document

string

Length: between 0 and 30 inclusive

RecountVersion

Recount Version

RecountVersion

None.

SupplierDocumentAddressId

integer

None.

SupplierId

integer

None.

TotalPaid

decimal number

None.

TotalPaidHc

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.

VatReverseChargeCodeId

Vat reverse charge code id

integer

Used in Cz legislation.

Sample:
{
  "AttachmentFileName": "sample string 1",
  "CurrencyId": 2,
  "DateCreated": "2021-05-09T01:28:40.7099115+00:00",
  "DateLastChange": "2021-05-09T01:28:40.7099115+00:00",
  "DateOfAccountingEvent": "2021-05-09T01:28:40.7099115+00:00",
  "DateOfIssue": "2021-05-09T01:28:40.7099115+00:00",
  "DateOfMaturity": "2021-05-09T01:28:40.7099115+00:00",
  "DateOfPayment": "2021-05-09T01:28:40.7099115+00:00",
  "DateOfReceiving": "2021-05-09T01:28:40.7099115+00:00",
  "DateOfTaxing": "2021-05-09T01:28:40.7099115+00:00",
  "DateOfVatApplication": "2021-05-09T01:28:40.7099115+00:00",
  "Description": "sample string 12",
  "DocumentNumber": "sample string 13",
  "DocumentSerialNumber": 14,
  "ExchangeRate": 15.0,
  "ExchangeRateAmount": 16.0,
  "Exported": 0,
  "IsSentToAccountant": true,
  "Items": [
    {
      "DateCreated": "2021-05-09T01:28:40.7099115+00:00",
      "DateLastChange": "2021-05-09T01:28:40.7099115+00:00",
      "IsCustomVat": true,
      "ItemType": 0,
      "Price": 4.0,
      "PriceListItemId": 1,
      "PriceTotalWithoutVat": 5.0,
      "PriceTotalWithoutVatHc": 6.0,
      "PriceTotalWithVat": 7.0,
      "PriceTotalWithVatHc": 8.0,
      "PriceUnitHc": 9.0,
      "VatRate": 10.0,
      "VatTotal": 11.0,
      "VatTotalHc": 12.0,
      "Amount": 1.0,
      "CustomVatRate": 1.0,
      "Name": "sample string 13",
      "PriceType": 0,
      "Unit": "sample string 14",
      "UnitPrice": 1.0,
      "VatCodeId": 1,
      "VatRateType": 0,
      "Id": 15
    }
  ],
  "MyCompanyDocumentAddressId": 18,
  "Note": "sample string 19",
  "OrderNumber": "sample string 20",
  "PaymentOptionId": 1,
  "PaymentStatus": 0,
  "ReceivedDocumentNumber": "sample string 21",
  "SupplierDocumentAddressId": 22,
  "SupplierId": 23,
  "TotalPaid": 24.0,
  "TotalPaidHc": 25.0,
  "TotalVat": 26.0,
  "TotalVatHc": 27.0,
  "TotalWithoutVat": 28.0,
  "TotalWithoutVatHc": 29.0,
  "TotalWithVat": 30.0,
  "TotalWithVatHc": 31.0,
  "VariableSymbol": "sample string 32",
  "VatOnPayStatus": 0,
  "VatReverseChargeCodeId": 1,
  "IsIncomeTax": true,
  "RecountVersion": 0,
  "Id": 34
}
Sample:
<ReceivedInvoiceApiModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Doklad.Api.ApiModels.ReceivedInvoice">
  <Id xmlns="http://schemas.datacontract.org/2004/07/Doklad.Api.ApiModels.BaseModels">34</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>
  <CurrencyId>2</CurrencyId>
  <DateCreated>2021-05-09T01:28:40.7099115+00:00</DateCreated>
  <DateLastChange>2021-05-09T01:28:40.7099115+00:00</DateLastChange>
  <DateOfAccountingEvent>2021-05-09T01:28:40.7099115+00:00</DateOfAccountingEvent>
  <DateOfIssue>2021-05-09T01:28:40.7099115+00:00</DateOfIssue>
  <DateOfMaturity>2021-05-09T01:28:40.7099115+00:00</DateOfMaturity>
  <DateOfPayment>2021-05-09T01:28:40.7099115+00:00</DateOfPayment>
  <DateOfReceiving>2021-05-09T01:28:40.7099115+00:00</DateOfReceiving>
  <DateOfTaxing>2021-05-09T01:28:40.7099115+00:00</DateOfTaxing>
  <DateOfVatApplication>2021-05-09T01:28:40.7099115+00:00</DateOfVatApplication>
  <Description>sample string 12</Description>
  <DocumentNumber>sample string 13</DocumentNumber>
  <DocumentSerialNumber>14</DocumentSerialNumber>
  <ExchangeRate>15</ExchangeRate>
  <ExchangeRateAmount>16</ExchangeRateAmount>
  <Exported>0</Exported>
  <IsIncomeTax>true</IsIncomeTax>
  <IsSentToAccountant>true</IsSentToAccountant>
  <Items>
    <ReceivedInvoiceItemApiModel>
      <Id xmlns="http://schemas.datacontract.org/2004/07/Doklad.Api.ApiModels.BaseModels">15</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>
      <Amount>1</Amount>
      <CustomVatRate>1</CustomVatRate>
      <Name>sample string 13</Name>
      <PriceListItemId i:nil="true" />
      <PriceType>0</PriceType>
      <Unit>sample string 14</Unit>
      <UnitPrice>1</UnitPrice>
      <VatCodeId>1</VatCodeId>
      <VatRateType>0</VatRateType>
      <DateCreated>2021-05-09T01:28:40.7099115+00:00</DateCreated>
      <DateLastChange>2021-05-09T01:28:40.7099115+00:00</DateLastChange>
      <IsCustomVat>true</IsCustomVat>
      <ItemType>0</ItemType>
      <Price>4</Price>
      <PriceListItemId>1</PriceListItemId>
      <PriceTotalWithVat>7</PriceTotalWithVat>
      <PriceTotalWithVatHc>8</PriceTotalWithVatHc>
      <PriceTotalWithoutVat>5</PriceTotalWithoutVat>
      <PriceTotalWithoutVatHc>6</PriceTotalWithoutVatHc>
      <PriceUnitHc>9</PriceUnitHc>
      <VatRate>10</VatRate>
      <VatTotal>11</VatTotal>
      <VatTotalHc>12</VatTotalHc>
    </ReceivedInvoiceItemApiModel>
  </Items>
  <MyCompanyDocumentAddressId>18</MyCompanyDocumentAddressId>
  <Note>sample string 19</Note>
  <OrderNumber>sample string 20</OrderNumber>
  <PaymentOptionId>1</PaymentOptionId>
  <PaymentStatus>0</PaymentStatus>
  <ReceivedDocumentNumber>sample string 21</ReceivedDocumentNumber>
  <RecountVersion>None</RecountVersion>
  <SupplierDocumentAddressId>22</SupplierDocumentAddressId>
  <SupplierId>23</SupplierId>
  <TotalPaid>24</TotalPaid>
  <TotalPaidHc>25</TotalPaidHc>
  <TotalVat>26</TotalVat>
  <TotalVatHc>27</TotalVatHc>
  <TotalWithVat>30</TotalWithVat>
  <TotalWithVatHc>31</TotalWithVatHc>
  <TotalWithoutVat>28</TotalWithoutVat>
  <TotalWithoutVatHc>29</TotalWithoutVatHc>
  <VariableSymbol>sample string 32</VariableSymbol>
  <VatOnPayStatus>0</VatOnPayStatus>
  <VatReverseChargeCodeId>1</VatReverseChargeCodeId>
</ReceivedInvoiceApiModel>