LineDetail

Fields (3)

• identificationDocumentLineIdentification

  Provides identification of the document line.

  Schema: DocumentLineIdentification

  Provides identification of the document line. the [type] property must be used for specifying the type of referred document type.

  • typeCodeAndIssuer

    Specifies a code and the issuer of this code.

    Schema: CodeAndIssuer

    Specifies a code and the issuer of this code.

    • codestringrequired

      Provides the code.

      Constraints: maxLength: 4

    • issuerstring

      Identification of the issuer of the code.

      Constraints: maxLength: 35

  • numberstring

    Unique and unambiguous identification of the referred document line.

    Constraints: maxLength: 35

  • relatedDatestring (date)ISO 8601

    Date associated with the referred document line.

• descriptionstring

  Description associated with the document line.

  Constraints: maxLength: 2048

• amountRemittanceAmount

  ISO20022: Provides details on the amounts of the document line.

  Schema: RemittanceAmount

  ISO20022: Provides details on the amounts of the document line. API: Amounts must always be set as positive values.

  Property	Description
  duePayableAmount	Amount specified is the exact amount due and payable to the creditor.
  discountAppliedAmount	Amount of discount to be applied to the amount due and payable to the creditor.
  creditNoteAmount	Amount of a credit note.
  taxAmount	Amount of the tax.
  adjustmentAmountAndReason	Specifies detailed information on the amount and reason of the adjustment.
  remittedAmount	Amount of money remitted.

  • duePayableAmountAmountType

    Structure aiming to embed the amount and the currency to be used.

    Schema: AmountType

    Structure aiming to embed the amount and the currency to be used.

    • amountnumber (float)required

      ISO20022: Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.

      ISO20022: Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.

      Constraints: pattern: `^\-{0,1}[0-9]{1,13}(\.[0-9]{0,5}){0,1}$`

    • currencyCurrencyCodeISO 4217required

      Specifies the currency of the amount or of the account.

      Schema: CurrencyCode

      Specifies the currency of the amount or of the account. A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

      Type: string

      Constraints: pattern: `^[A-Z]{3,3}$`

  • discountAppliedAmountTypedAmount

    ISO20022: Typed Amount

    Schema: TypedAmount

    ISO20022: Typed Amount API: Amounts must always be set as positive values.

    • typestring

      Type of the amount

      Constraints: maxLength: 35

    • amountAmountTyperequired

      Structure aiming to embed the amount and the currency to be used.

      Schema: AmountType

      Structure aiming to embed the amount and the currency to be used.

      • amountnumber (float)required

        ISO20022: Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.

        ISO20022: Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.

        Constraints: pattern: `^\-{0,1}[0-9]{1,13}(\.[0-9]{0,5}){0,1}$`

      • currencyCurrencyCodeISO 4217required

        Specifies the currency of the amount or of the account.

        Schema: CurrencyCode

        Specifies the currency of the amount or of the account. A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

        Type: string

        Constraints: pattern: `^[A-Z]{3,3}$`

  • creditNoteAmountAmountType

    Structure aiming to embed the amount and the currency to be used.

    Schema: AmountType

    Structure aiming to embed the amount and the currency to be used.

    • amountnumber (float)required

      ISO20022: Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.

      ISO20022: Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.

      Constraints: pattern: `^\-{0,1}[0-9]{1,13}(\.[0-9]{0,5}){0,1}$`

    • currencyCurrencyCodeISO 4217required

      Specifies the currency of the amount or of the account.

      Schema: CurrencyCode

      Specifies the currency of the amount or of the account. A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

      Type: string

      Constraints: pattern: `^[A-Z]{3,3}$`

  • taxAmountTypedAmount

    ISO20022: Typed Amount

    Schema: TypedAmount

    ISO20022: Typed Amount API: Amounts must always be set as positive values.

    • typestring

      Type of the amount

      Constraints: maxLength: 35

    • amountAmountTyperequired

      Structure aiming to embed the amount and the currency to be used.

      Schema: AmountType

      Structure aiming to embed the amount and the currency to be used.

      • amountnumber (float)required

        ISO20022: Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.

        ISO20022: Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.

        Constraints: pattern: `^\-{0,1}[0-9]{1,13}(\.[0-9]{0,5}){0,1}$`

      • currencyCurrencyCodeISO 4217required

        Specifies the currency of the amount or of the account.

        Schema: CurrencyCode

        Specifies the currency of the amount or of the account. A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

        Type: string

        Constraints: pattern: `^[A-Z]{3,3}$`

  • adjustmentAmountAndReasonDocumentAdjustment

    ISO20022: Specifies detailed information on the amount and reason of the adjustment.

    Schema: DocumentAdjustment

    ISO20022: Specifies detailed information on the amount and reason of the adjustment. API: Amounts must always be set as positive values.

    • amountAmountTyperequired

      Structure aiming to embed the amount and the currency to be used.

      Schema: AmountType

      Structure aiming to embed the amount and the currency to be used.

      • amountnumber (float)required

        ISO20022: Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.

        ISO20022: Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.

        Constraints: pattern: `^\-{0,1}[0-9]{1,13}(\.[0-9]{0,5}){0,1}$`

      • currencyCurrencyCodeISO 4217required

        Specifies the currency of the amount or of the account.

        Schema: CurrencyCode

        Specifies the currency of the amount or of the account. A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

        Type: string

        Constraints: pattern: `^[A-Z]{3,3}$`

    • creditDebitIndicatorCreditDebitIndicator

      Accounting flow of the amount

      Schema: CreditDebitIndicator

      Code	Description
      CRDT	Credit type amount
      DBIT	Debit type amount

    • reasonstring

      Specifies the reason for the adjustment.

      Constraints: maxLength: 4

    • additionalInformationstring

      Provides further details on the document adjustment.

      Constraints: maxLength: 140

  • remittedAmountAmountType

    Structure aiming to embed the amount and the currency to be used.

    Schema: AmountType

    Structure aiming to embed the amount and the currency to be used.

    • amountnumber (float)required

      ISO20022: Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.

      ISO20022: Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.

      Constraints: pattern: `^\-{0,1}[0-9]{1,13}(\.[0-9]{0,5}){0,1}$`

    • currencyCurrencyCodeISO 4217required

      Specifies the currency of the amount or of the account.

      Schema: CurrencyCode

      Specifies the currency of the amount or of the account. A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

      Type: string

      Constraints: pattern: `^[A-Z]{3,3}$`