Get payments

Get the payments for an invoice

Query parameters

NameDescription
guid globally unique identifier

Guid of the invoice

Required

organizationId string

Returns

200 (OK) Returns a collection of payments.

NameDescription
Payments Payment[] Show model
NameDescription
Guid globally unique identifier

The Guid of the payment

DepositAccountNumber integer

Account number of an deposit account. Can be null if paid by ledger, creditnote or invoice.

ExternalReference string

Your external id This can be used for ID'ing in external apps/services e.g. a web shop. The maximum length is 128 characters

PaymentDate string

The date of the payment. This should be in the format YYYY-MM-DD e.g. 2015-12-02. Defaults to today.

Description string

Description. Fx.: 'Payment of invoice'.

Amount decimal number

Amount. Has to be different from 0.

AmountInForeignCurrency decimal number

When handling a payment for a voucher with a foreign currency, this property is required. This property together with Amount will be used to calculate exchange rate.

List of payments

RemainingAmount decimal number

The remaining amount to be paid. Might be negative if the invoice is overpaid.

PaidAmount decimal number

The sum of the registered payments on the invoice.

InvoiceTotalIncludingReminderExpenses decimal number

The total amount of the invoice, including reminder fees, if any.

v1/{organizationId}/invoices/{guid}/payments

Response Formats

{
  "Payments": [
    {
      "Guid": "763a11d0-c92c-4d20-9064-84601a7c589b",
      "DepositAccountNumber": 1000,
      "ExternalReference": "Fx. WebShopID:42",
      "PaymentDate": "2015-12-02",
      "Description": "Payment of invoice",
      "Amount": 20.0,
      "AmountInForeignCurrency": 15.0
    },
    {
      "Guid": "763a11d0-c92c-4d20-9064-84601a7c589b",
      "DepositAccountNumber": 1000,
      "ExternalReference": "Fx. WebShopID:42",
      "PaymentDate": "2015-12-02",
      "Description": "Payment of invoice",
      "Amount": 20.0,
      "AmountInForeignCurrency": 15.0
    }
  ],
  "RemainingAmount": 0.0,
  "PaidAmount": 1000.0,
  "InvoiceTotalIncludingReminderExpenses": 1000.0
}