List payments from a single sales invoice

List payments from a single sales invoice

GEThttps://apione.zwapgrid.com/accounting/api/v1/consents/{consentId}/salesinvoices/{salesInvoiceId}/payments
Path parameters
consentId*string (uuid)

The consent for which you wish to list invoices.

salesInvoiceId*string

The id of the invoice that you wish to retrieve payments for.

Header parameters
Response

Returns payments of an invoice related to specific consent.

Body
metaPagedResultMetadataDto (object)
datanullable array of InvoicePaymentDto (object)
Request
const response = await fetch('https://apione.zwapgrid.com/accounting/api/v1/consents/{consentId}/salesinvoices/{salesInvoiceId}/payments', {
    method: 'GET',
    headers: {
      "x-correlation-id": "123e4567-e89b-12d3-a456-426614174000"
    },
});
const data = await response.json();
Response
{
  "meta": {},
  "data": [
    {
      "id": "text",
      "paymentId": "text",
      "receivedDate": "text",
      "paidDate": "text",
      "bookedIndicator": false,
      "bookedDate": "text",
      "accountingAccount": {
        "id": "text",
        "accountingAccountId": "text",
        "name": "text",
        "description": {
          "text": "text",
          "languageId": "text"
        }
      },
      "billingReferences": [
        {
          "invoiceDocumentReferences": [
            {
              "id": "text",
              "schemeId": "text"
            }
          ]
        }
      ],
      "creditAmount": {
        "amount": 0,
        "currencyId": "text"
      },
      "debitAmount": {
        "amount": 0,
        "currencyId": "text"
      }
    }
  ]
}

Last updated