Request Information
Returns proforma invoice list with related entities such as contact information etc.
Example URL:
v2.0/ProformaInvoices/Expand
None.
None.
Response Information
IPageOfProformaInvoiceApiModelExpand
| Name | Description | Type | Additional information |
|---|---|---|---|
| Data |
List of entities on this page |
Collection of ProformaInvoiceApiModelExpand |
None. |
| TotalItems |
Total number of entries |
integer |
None. |
| TotalPages |
Total number of pages |
integer |
None. |
Sample:
{
"Data": [
{
"ConstantSymbol": {
"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-02T05:34:59.0566241+00:00",
"Name": "sample string 4",
"NameEnglish": "sample string 5",
"IsEuMember": true,
"Id": 7
},
"CountryId": 2,
"DateLastChange": "2024-11-02T05:34:59.0566241+00:00",
"IsDefault": true,
"Name": "sample string 5",
"Id": 6
},
"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-02T05:34:59.0566241+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-02T05:34:59.0566241+00:00",
"IsDefault": true,
"IsRounded": true,
"Name": "sample string 5",
"IsAutoPayment": true,
"Id": 7
},
"Purchaser": {
"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-02T05:34:59.0566241+00:00",
"Name": "sample string 4",
"NameEnglish": "sample string 5",
"IsEuMember": true,
"Id": 7
},
"CountryId": 2,
"DateLastChange": "2024-11-02T05:34:59.0566241+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-02T05:34:59.0566241+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-02T05:34:59.0566241+00:00",
"Name": "sample string 4",
"NameEnglish": "sample string 5",
"IsEuMember": true,
"Id": 7
},
"AddressIdg": "efee3523-ff80-4cb6-bd8d-005f2c24eabe",
"CreditCheck": 0,
"DateLastChange": "2024-11-02T05:34:59.0566241+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-02T05:34:59.0566241+00:00",
"Name": "sample string 4",
"NameEnglish": "sample string 5",
"IsEuMember": true,
"Id": 7
},
"CountryId": 2,
"DateLastChange": "2024-11-02T05:34:59.0566241+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-02T05:34:59.0566241+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"
},
"PurchaserDocumentAddress": {
"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-02T05:34:59.0566241+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",
"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:34:59.0566241+00:00",
"DateOfAccountingEvent": "2024-11-02T05:34:59.0566241+00:00",
"DateOfIssue": "2024-11-02T05:34:59.0566241+00:00",
"DateOfLastReminder": "2024-11-02T05:34:59.0566241+00:00",
"DateOfMaturity": "2024-11-02T05:34:59.0566241+00:00",
"DateOfPayment": "2024-11-02T05:34:59.0566241+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:34:59.0566241+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
}
],
"TotalItems": 1,
"TotalPages": 1
}
Sample:
Sample not available.
Sample:
Sample not available.