GET v2.0/CreditNotes/{id}/Expand

Request Information

Returns Credit note with related entities by Id.

Example URL:
 v2.0/CreditNotes/{id}/Expand

URL parameters
Body parameters

Name	Description	Type	Additional information
id	Credit note Id	integer	Required
id	Credit note Id	integer	Required

None.

Response Information

Resource Description
Response Formats

CreditNoteApiModelExpand

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.
ConstantSymbol		ConstantSymbolApiModel	None.
ConstantSymbolId	Constant symbol Id	integer	None.
CreditNoteForDocumentId	Id of the issued invoice	integer	None.
CreditNoteItems	Invoice items	Collection of CreditNoteItemApiModel	None.
CreditNoteReason	Reason for issuing a credit note	string	None.
Currency		CurrencyApiModel	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.
DateOfTaxing	Date of taxing	date	None.
DateOfVatApplication	Date of VAT application	date	Used in Sk legislation.
DateOfVatClaim	Date of VAT claim	date	None.
Description	Description	string	None.
Discount	Discount for invoice	decimal number	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	Used in Cz legislation.
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.
HasVatRegimeOss	Has OSS regime	boolean	None.
Id	Resource identifier	integer	Readonly
IsEet	Flag indicating whether the sales receipt is registered in EET.	boolean	Used in Cz legislation.
IsIncomeTax	Include subject to income tax	boolean	Used in Cz legislation.
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.
MyCompanyDocumentAddress		DocumentAddressApiModel	None.
MyCompanyDocumentAdrressId	My company document address Id	integer	None.
Note	Note	string	None.
NoteForCreditNote	Note on the acceptance of credit note	string	None.
NumericSequenceId	Numeric sequence id	integer	None.
OrderNumber	Order number	string	Length: between 0 and 20 inclusive
PaymentOption		PaymentOptionApiModel	None.
PaymentOptionId		integer	None.
PaymentStatus		PaymentStatus	None.
Purchaser	Info about purchaser from the address book	ContactApiModelExpand	None.
PurchaserDocumentAddress		DocumentAddressApiModel	None.
PurchaserDocumentAddressId		integer	None.
PurchaserId		integer	None.
RecountVersion	Recount Version	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	Total amount of VAT in used currency	decimal number	None.
TotalVatHc	Total amount of VAT in home currency	decimal number	None.
TotalWithoutVat	Total amount without VAT in the used currency.	decimal number	None.
TotalWithoutVatHc	Total amount without VAT in home currency	decimal number	None.
TotalWithVat	Total amount with VAT in used currency	decimal number	None.
TotalWithVatHc	Total amount with VAT in home currency	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.

Sample:

{
  "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-02T03:42:34.5209078+00:00",
      "Name": "sample string 4",
      "NameEnglish": "sample string 5",
      "IsEuMember": true,
      "Id": 7
    },
    "CountryId": 2,
    "DateLastChange": "2024-11-02T03:42:34.5209078+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-02T03:42:34.5209078+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-02T03:42:34.5209078+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-02T03:42:34.5209078+00:00",
            "Name": "sample string 4",
            "NameEnglish": "sample string 5",
            "IsEuMember": true,
            "Id": 7
          },
          "CountryId": 2,
          "DateLastChange": "2024-11-02T03:42:34.5209078+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-02T03:42:34.5209078+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-02T03:42:34.5209078+00:00",
      "Name": "sample string 4",
      "NameEnglish": "sample string 5",
      "IsEuMember": true,
      "Id": 7
    },
    "AddressIdg": "ff7da964-a6a1-4aaf-8aa2-6b3b1ec9df47",
    "CreditCheck": 0,
    "DateLastChange": "2024-11-02T03:42:34.5209078+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-02T03:42:34.5209078+00:00",
          "Name": "sample string 4",
          "NameEnglish": "sample string 5",
          "IsEuMember": true,
          "Id": 7
        },
        "CountryId": 2,
        "DateLastChange": "2024-11-02T03:42:34.5209078+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-02T03:42:34.5209078+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-02T03:42:34.5209078+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-02T03:42:34.5209078+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-02T03:42:34.5209078+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-02T03:42:34.5209078+00:00",
  "DateOfAccountingEvent": "2024-11-02T03:42:34.5209078+00:00",
  "DateOfIssue": "2024-11-02T03:42:34.5209078+00:00",
  "DateOfLastReminder": "2024-11-02T03:42:34.5209078+00:00",
  "DateOfMaturity": "2024-11-02T03:42:34.5209078+00:00",
  "DateOfPayment": "2024-11-02T03:42:34.5209078+00:00",
  "DateOfTaxing": "2024-11-02T03:42:34.5209078+00:00",
  "DateOfVatApplication": "2024-11-02T03:42:34.5209078+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
}

Sample:

Sample not available.

Sample:

Sample not available.