---
title: "GetDepositedInvoices"
method: POST
path: "/v2/GetDepositedInvoices"
tags: ["Reports"]
---

# GetDepositedInvoices

`POST /v2/GetDepositedInvoices`

## Request

- Base URL: `https://apitest.myfatoorah.com`
- URL: `https://apitest.myfatoorah.com/v2/GetDepositedInvoices`
- Auth: HTTP bearer

Retrieves the list of invoices included in a specific deposit by deposit reference.

## Request body

- object
  - `DepositReference` string, required: The Deposit Reference you would like to receive its invoices.
  - `Type` 'Vendor' | 'Supplier': Vendor (Default): The deposit reference belongs to the vendor. Supplier: The deposit reference belongs to a supplier.
  - `SupplierCode` integer: The supplier code to which the deposit reference belongs. Mandatory if Type value is Supplier.

## Response `200`

Successful response

- object
  - `IsSuccess` boolean: Indicates if the request was successful
  - `Message` string: Response message
  - `ValidationErrors` object[]: List of validation errors if any
    - `Name` string
    - `Error` string
  - `Data` object[]: List of invoice details included in the deposit
    - `InvoiceId` number: InvoiceId
    - `PaymentGateway` string: Payment gateway used
    - `PaymentId` string
    - `InvoiceReference` string
    - `CustomerReference` string
    - `CreatedDate` string, date-time: Date when the invoice was created
    - `InvoiceValue` string
    - `PaidCurrencyValue` string: Amount paid in the payment currency
    - `PaidCurrency` string: Currency code of the payment
    - `InvoiceDisplayValue` string
    - `DueValue` string: The total amount of the invoice
    - `PaidDate` string, date-time: Date when the payment was made
    - `TotalServiceCharge` string: Transaction service charge
    - `DueDeposit` string: The amount received by the vendor/supplier
    - `DepositReference` string
    - `DepositDate` string, date-time: Date when the deposit was made

---

[API](https://skmtc.dev/myfatoorah/apis/myfatoorah-api-v2.md) - [All operations](https://skmtc.dev/myfatoorah/apis/myfatoorah-api-v2/llms.txt) - [OpenAPI document](https://skmtc.dev/myfatoorah/apis/myfatoorah-api-v2/revisions/4c0c2a3af558?raw)