Request Information
Returns credit note list with related entities such as contact information etc.
Example URL:
v2.0/CreditNotes/Expand
None.
None.
Response Information
IPageOfCreditNoteApiModelExpand
| Name | Description | Type | Additional information |
|---|---|---|---|
| Data |
List of entities on this page |
Collection of CreditNoteApiModelExpand |
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-08T03:40:57.9877002+00:00",
"Name": "sample string 4",
"NameEnglish": "sample string 5",
"IsEuMember": true,
"Id": 7
},
"CountryId": 2,
"DateLastChange": "2024-11-08T03:40:57.9877002+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-08T03:40:57.9877002+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-08T03:40:57.9877002+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-08T03:40:57.9877002+00:00",
"Name": "sample string 4",
"NameEnglish": "sample string 5",
"IsEuMember": true,
"Id": 7
},
"CountryId": 2,
"DateLastChange": "2024-11-08T03:40:57.9877002+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-08T03:40:57.9877002+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-08T03:40:57.9877002+00:00",
"Name": "sample string 4",
"NameEnglish": "sample string 5",
"IsEuMember": true,
"Id": 7
},
"AddressIdg": "9f513efc-d830-4dc0-9ddf-93535b04019b",
"CreditCheck": 0,
"DateLastChange": "2024-11-08T03:40:57.9877002+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-08T03:40:57.9877002+00:00",
"Name": "sample string 4",
"NameEnglish": "sample string 5",
"IsEuMember": true,
"Id": 7
},
"CountryId": 2,
"DateLastChange": "2024-11-08T03:40:57.9877002+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-08T03:40:57.9877002+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-08T03:40:57.9877002+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
},
"CreditNoteForDocumentId": 1,
"CreditNoteItems": [
{
"Code": "sample string 1",
"DateLastChange": "2024-11-08T03:40:57.9877002+00:00",
"IsRoundedItem": true,
"IsTaxMovement": true,
"ItemType": 0,
"Price": 5.0,
"PriceTotalWithoutVat": 6.0,
"PriceTotalWithoutVatHc": 7.0,
"PriceTotalWithVat": 8.0,
"PriceTotalWithVatHc": 9.0,
"PriceUnitVat": 10.0,
"PriceUnitVatHc": 11.0,
"PriceUnitWithoutVat": 12.0,
"PriceUnitWithoutVatHc": 13.0,
"PriceUnitWithVat": 14.0,
"PriceUnitWithVatHc": 15.0,
"TotalPrice": 16.0,
"VatRate": 17.0,
"VatTotal": 18.0,
"VatTotalHc": 19.0,
"Amount": 20.0,
"Name": "sample string 21",
"PriceListItemId": 1,
"PriceType": 0,
"Unit": "sample string 22",
"UnitPrice": 23.0,
"VatCodeId": 1,
"VatRateType": 0,
"Id": 24
}
],
"CreditNoteReason": "sample string 2",
"DateOfVatClaim": "2024-11-08T03:40:57.9877002+00:00",
"NoteForCreditNote": "sample string 4",
"NumericSequenceId": 5,
"AttachmentFileName": "sample string 6",
"BaseTaxBasicRate": 7.0,
"BaseTaxBasicRateHc": 8.0,
"BaseTaxReducedRate1": 9.0,
"BaseTaxReducedRate1Hc": 10.0,
"BaseTaxReducedRate2": 11.0,
"BaseTaxReducedRate2Hc": 12.0,
"BaseTaxZeroRate": 13.0,
"BaseTaxZeroRateHc": 14.0,
"ConstantSymbolId": 15,
"CurrencyId": 16,
"DateLastChange": "2024-11-08T03:40:57.9877002+00:00",
"DateOfAccountingEvent": "2024-11-08T03:40:57.9877002+00:00",
"DateOfIssue": "2024-11-08T03:40:57.9877002+00:00",
"DateOfLastReminder": "2024-11-08T03:40:57.9877002+00:00",
"DateOfMaturity": "2024-11-08T03:40:57.9877002+00:00",
"DateOfPayment": "2024-11-08T03:40:57.9877002+00:00",
"DateOfTaxing": "2024-11-08T03:40:57.9877002+00:00",
"DateOfVatApplication": "2024-11-08T03:40:57.9877002+00:00",
"Description": "sample string 25",
"Discount": 26.0,
"DocumentNumber": "sample string 27",
"DocumentSerialNumber": 28,
"EetResponsibility": 0,
"ExchangeRate": 29.0,
"ExchangeRateAmount": 30.0,
"Exported": 0,
"HasVatRegimeOss": true,
"IsEet": true,
"IsSentToAccountant": true,
"IsSentToPurchaser": true,
"ItemsTextPrefix": "sample string 35",
"ItemsTextSuffix": "sample string 36",
"LanguageCode": "sample string 37",
"LanguageId": 38,
"Maturity": 39,
"MyCompanyDocumentAdrressId": 40,
"Note": "sample string 41",
"OrderNumber": "sample string 42",
"PaymentOptionId": 43,
"PaymentStatus": 0,
"PurchaserDocumentAddressId": 44,
"PurchaserId": 45,
"RemindersCount": 46,
"ReportColorValue": "sample string 47",
"ReportId": 48,
"RoundingDifference": 49.0,
"TaxBasicRate": 50.0,
"TaxBasicRateHc": 51.0,
"TaxReducedRate1": 52.0,
"TaxReducedRate1Hc": 53.0,
"TaxReducedRate2": 54.0,
"TaxReducedRate2Hc": 55.0,
"TotalBasicRate": 56.0,
"TotalBasicRateHc": 57.0,
"TotalReducedRate1": 58.0,
"TotalReducedRate1Hc": 59.0,
"TotalReducedRate2": 60.0,
"TotalReducedRate2Hc": 61.0,
"TotalVat": 62.0,
"TotalVatHc": 63.0,
"TotalWithoutVat": 64.0,
"TotalWithoutVatHc": 65.0,
"TotalWithVat": 66.0,
"TotalWithVatHc": 67.0,
"VariableSymbol": "sample string 68",
"VatOnPayStatus": 0,
"VatRateBasic": 69.0,
"VatRateReduced1": 70.0,
"VatRateReduced2": 71.0,
"VatRegime": 0,
"IsIncomeTax": true,
"RecountVersion": 0,
"Id": 73
}
],
"TotalItems": 1,
"TotalPages": 1
}
Sample:
Sample not available.
Sample:
Sample not available.