Request Information
Returns Received invoice with related entities by Id.
Example URL:
v2.0/ReceivedInvoices/{id}/Expand
| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
Invoice Id |
integer |
Required |
| id |
Invoice Id |
integer |
Required |
None.
Response Information
ReceivedInvoiceApiModelExpand
| Name | Description | Type | Additional information |
|---|---|---|---|
| AttachmentFileName |
Name of the attached file. If no attachment is included, this will be empty. |
string |
None. |
| Currency | CurrencyApiModel |
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. |
|
| MyCompanyDocumentAddress | DocumentAddressApiModel |
None. |
|
| MyCompanyDocumentAddressId | integer |
None. |
|
| Note | string |
None. |
|
| OrderNumber | string |
Length: between 0 and 20 inclusive |
|
| PaymentOption | PaymentOptionApiModel |
None. |
|
| 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. |
| Supplier |
Info about supplier from the address book |
ContactApiModelExpand |
None. |
| SupplierDocumentAddress | DocumentAddressApiModel |
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. |
| VatRegime |
VAT regime |
VatRegime |
None. |
| VatReverseChargeCodeId |
Vat reverse charge code id |
integer |
Used in Cz legislation. |
Sample:
{
"Currency": {
"Code": "sample string 1",
"Country": "sample string 2",
"Name": "sample string 3",
"Priority": 4,
"Symbol": "sample string 5",
"Id": 6
},
"MyCompanyDocumentAddress": {
"AccountNumber": "sample string 1",
"Bank": "sample string 2",
"BankNumberCode": "sample string 3",
"City": "sample string 4",
"Country": "sample string 5",
"CountryId": 1,
"DateLastChange": "2024-11-13T00:03:49.6144656+00:00",
"Email": "sample string 7",
"Fax": "sample string 8",
"Firstname": "sample string 9",
"Iban": "sample string 10",
"IdentificationNumber": "sample string 11",
"Mobile": "sample string 12",
"NickName": "sample string 13",
"Phone": "sample string 14",
"PostalCode": "sample string 15",
"Street": "sample string 16",
"Surname": "sample string 17",
"Swift": "sample string 18",
"Title": "sample string 19",
"VatIdentificationNumber": "sample string 20",
"VatIdentificationNumberSk": "sample string 21",
"Www": "sample string 22",
"Id": 23
},
"PaymentOption": {
"Code": "sample string 1",
"DateLastChange": "2024-11-13T00:03:49.6144656+00:00",
"IsDefault": true,
"IsRounded": true,
"Name": "sample string 5",
"IsAutoPayment": true,
"Id": 7
},
"Supplier": {
"BankAccounts": [
{
"Bank": {
"Code": "sample string 1",
"Country": {
"Code": "sample string 1",
"Currency": {
"Code": "sample string 1",
"Country": "sample string 2",
"Name": "sample string 3",
"Priority": 4,
"Symbol": "sample string 5",
"Id": 6
},
"CurrencyId": 2,
"DateLastChange": "2024-11-13T00:03:49.6144656+00:00",
"Name": "sample string 4",
"NameEnglish": "sample string 5",
"IsEuMember": true,
"Id": 7
},
"CountryId": 2,
"DateLastChange": "2024-11-13T00:03:49.6144656+00:00",
"Name": "sample string 4",
"NumberCode": "sample string 5",
"Swift": "sample string 6",
"IsOutOfDate": true,
"Id": 8
},
"Currency": {
"Code": "sample string 1",
"Country": "sample string 2",
"Name": "sample string 3",
"Priority": 4,
"Symbol": "sample string 5",
"Id": 6
},
"DateLastChange": "2024-11-13T00:03:49.6144656+00:00",
"IsDefault": true,
"CurrencyId": 3,
"AccountNumber": "sample string 4",
"BankId": 1,
"Iban": "sample string 5",
"Name": "sample string 6",
"Swift": "sample string 7",
"Id": 8
}
],
"Country": {
"Code": "sample string 1",
"Currency": {
"Code": "sample string 1",
"Country": "sample string 2",
"Name": "sample string 3",
"Priority": 4,
"Symbol": "sample string 5",
"Id": 6
},
"CurrencyId": 2,
"DateLastChange": "2024-11-13T00:03:49.6144656+00:00",
"Name": "sample string 4",
"NameEnglish": "sample string 5",
"IsEuMember": true,
"Id": 7
},
"AddressIdg": "70986063-410e-4cf6-bf78-3d03e9078757",
"CreditCheck": 0,
"DateLastChange": "2024-11-13T00:03:49.6144656+00:00",
"DefaultBankAccount": {
"Bank": {
"Code": "sample string 1",
"Country": {
"Code": "sample string 1",
"Currency": {
"Code": "sample string 1",
"Country": "sample string 2",
"Name": "sample string 3",
"Priority": 4,
"Symbol": "sample string 5",
"Id": 6
},
"CurrencyId": 2,
"DateLastChange": "2024-11-13T00:03:49.6144656+00:00",
"Name": "sample string 4",
"NameEnglish": "sample string 5",
"IsEuMember": true,
"Id": 7
},
"CountryId": 2,
"DateLastChange": "2024-11-13T00:03:49.6144656+00:00",
"Name": "sample string 4",
"NumberCode": "sample string 5",
"Swift": "sample string 6",
"IsOutOfDate": true,
"Id": 8
},
"Currency": {
"Code": "sample string 1",
"Country": "sample string 2",
"Name": "sample string 3",
"Priority": 4,
"Symbol": "sample string 5",
"Id": 6
},
"DateLastChange": "2024-11-13T00:03:49.6144656+00:00",
"IsDefault": true,
"CurrencyId": 3,
"AccountNumber": "sample string 4",
"BankId": 1,
"Iban": "sample string 5",
"Name": "sample string 6",
"Swift": "sample string 7",
"Id": 8
},
"Id": 3,
"CompanyName": "sample string 4",
"CountryId": 5,
"IsRegisteredForVatOnPay": true,
"DefaultInvoiceMaturity": 1,
"City": "sample string 7",
"DiscountPercentage": 1.0,
"Email": "sample string 8",
"Fax": "sample string 9",
"Firstname": "sample string 10",
"IdentificationNumber": "sample string 11",
"IsSendReminder": true,
"Mobile": "sample string 12",
"Phone": "sample string 13",
"PostalCode": "sample string 14",
"Street": "sample string 15",
"Surname": "sample string 16",
"Title": "sample string 17",
"VatIdentificationNumber": "sample string 18",
"VatIdentificationNumberSk": "sample string 19",
"Www": "sample string 20"
},
"SupplierDocumentAddress": {
"AccountNumber": "sample string 1",
"Bank": "sample string 2",
"BankNumberCode": "sample string 3",
"City": "sample string 4",
"Country": "sample string 5",
"CountryId": 1,
"DateLastChange": "2024-11-13T00:03:49.6144656+00:00",
"Email": "sample string 7",
"Fax": "sample string 8",
"Firstname": "sample string 9",
"Iban": "sample string 10",
"IdentificationNumber": "sample string 11",
"Mobile": "sample string 12",
"NickName": "sample string 13",
"Phone": "sample string 14",
"PostalCode": "sample string 15",
"Street": "sample string 16",
"Surname": "sample string 17",
"Swift": "sample string 18",
"Title": "sample string 19",
"VatIdentificationNumber": "sample string 20",
"VatIdentificationNumberSk": "sample string 21",
"Www": "sample string 22",
"Id": 23
},
"AttachmentFileName": "sample string 1",
"CurrencyId": 2,
"DateCreated": "2024-11-13T00:03:49.6144656+00:00",
"DateLastChange": "2024-11-13T00:03:49.6144656+00:00",
"DateOfAccountingEvent": "2024-11-13T00:03:49.6144656+00:00",
"DateOfIssue": "2024-11-13T00:03:49.6144656+00:00",
"DateOfMaturity": "2024-11-13T00:03:49.6144656+00:00",
"DateOfPayment": "2024-11-13T00:03:49.6144656+00:00",
"DateOfReceiving": "2024-11-13T00:03:49.6144656+00:00",
"DateOfTaxing": "2024-11-13T00:03:49.6144656+00:00",
"DateOfVatApplication": "2024-11-13T00:03:49.6144656+00:00",
"Description": "sample string 12",
"DocumentNumber": "sample string 13",
"DocumentSerialNumber": 14,
"ExchangeRate": 15.0,
"ExchangeRateAmount": 16.0,
"Exported": 0,
"IsSentToAccountant": true,
"Items": [
{
"DateCreated": "2024-11-13T00:03:49.6144656+00:00",
"DateLastChange": "2024-11-13T00:03:49.6144656+00:00",
"IsCustomVat": true,
"ItemType": 0,
"Price": 4.0,
"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",
"PriceListItemId": 1,
"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,
"VatRegime": 0,
"Id": 34
}
Sample:
Sample not available.
Sample:
Sample not available.