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

Get the payments for an invoice

Request Information

URI Parameters

NameDescriptionTypeAdditional information
guid

Guid of the invoice

globally unique identifier

Required

organizationId

string

None.

Body Parameters

Response Information

Resource Description

200 (OK) Returns a collection of payments.

InvoicePayments
NameDescriptionType
Payments

List of payments

Collection of Payment
RemainingAmount

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

decimal number
PaidAmount

The sum of the registered payments on the invoice.

decimal number
InvoiceTotalIncludingReminderExpenses

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

decimal number
Sample:
{
  "Payments": [
    {
      "Guid": "1503bb07-d0cd-4dfe-b6be-531e516c4817",
      "DepositAccountNumber": 1000,
      "ExternalReference": "Fx. WebShopID:42",
      "PaymentDate": "2015-12-02",
      "Description": "Payment of invoice",
      "Amount": 20.0,
      "AmountInForeignCurrency": 15.0
    },
    {
      "Guid": "1503bb07-d0cd-4dfe-b6be-531e516c4817",
      "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
}