GetInvoicesByDepositReference

Overview

The "GetInvoicesByDepositReference" endpoint is a POST request. It is used to get the list of invoices included in a deposit.

The endpoint on Swagger: Reports_GetInvoicesByDepositReference.

Now, we are going to declare the endpoint and its models along with each accepted parameter and possible value.

📘
Request Header
Add "Authorization": "Bearer {Token}" to request header. Token of demo configuration can be found here.

Request Model

The request is a POST request with the following parameters:

Input Parameter	Type	Description
DepositReference	string	the Deposit Reference you would like to receive its invoices.

Response Model

After viewing the Response Model that you will get as a result of your request, here, you will find full details about the Data Model of this API endpoint. Let's check it and its contents.
The data model is a list of InvoiceDetailsModel which is explained below.

InvoiceDetailsModel

Response Field	Type	Description
InvoiceId	number	InvoiceId
PaymentGateway	string
PaymentId	string
InvoiceReference	string
CustomerReference	string
CreatedDate	date
InvoiceValue	string
PaidCurrencyValue	string
PaidCurrency	string
InvoiceDisplayValue	string
DueValue	string	Total amount of the invoice
PaidDate	date
TotalServiceCharge	string	Transaction service Charge
DueDeposit	string	The amount received by vendor
DepositReference	string
DepositDate	date

Sample Message

{
  "DepositReference": "2022000005"
}

{
  "IsSuccess": true,
  "Message": null,
  "ValidationErrors": null,
  "Data": [
    {
      "InvoiceId": 1923498,
      "PaymentGateway": "VISA/MASTER",
      "PaymentId": "07071923498138979374",
      "InvoiceReference": "2022003047",
      "CustomerReference": null,
      "CreatedDate": "2022-12-22T13:22:23.417",
      "InvoiceValue": "10.000",
      "PaidCurrencyValue": "10.000",
      "PaidCurrency": "KD",
      "InvoiceDisplayValue": "10.000",
      "DueValue": "10.000",
      "PaidDate": "2022-12-27T11:20:06.327",
      "TotalServiceCharge": "0.295",
      "DueDeposit": "9.690",
      "DepositReference": "2022000005",
      "DepositDate": "2022-12-29T11:23:00"
    },
    {
      "InvoiceId": 1923992,
      "PaymentGateway": "KNET",
      "PaymentId": "100202235973495977",
      "InvoiceReference": "2022003049",
      "CustomerReference": null,
      "CreatedDate": "2022-12-22T16:11:58.813",
      "InvoiceValue": "100.000",
      "PaidCurrencyValue": "100.000",
      "PaidCurrency": "KD",
      "InvoiceDisplayValue": "100.000",
      "DueValue": "100.000",
      "PaidDate": "2022-12-25T10:23:42.417",
      "TotalServiceCharge": "2.000",
      "DueDeposit": "97.900",
      "DepositReference": "2022000005",
      "DepositDate": "2022-12-29T11:23:00"
    }...
  ]
}