---
title: "Retrieve Invoice"
method: POST
path: "/pgsi/ve1_2/invoice/get"
tags: ["Invoice"]
---

# Retrieve Invoice

`POST /pgsi/ve1_2/invoice/get`

Merchants can retrieve invoice details by using mercid and invoice_number

## Headers

- `BD-Traceid` string, required
- `BD-Timestamp` string, required
- `Content-Type` string, required
- `Accept` string, required

## Request body

- object
  - `mercid` string — Unique identifier as defined by BillDesk for each merchant
  - `invoice_number` string — Unique number assigned by merchant for the invoice

## Response `200`

OK

- object
  - `invoice_number` string — Unique number assigned by merchant for the invoice
  - `objectid` 'transaction' | 'authentication' | 'mandate' | 'invoice' | 'cardaccount' | 'validatevpa' | 'dispute' | 'settlement' | 'altid' | 'mandate_token' | 'accountvalidation' — String representing the object's type. Objects of the same type share the same value.
  - `invoice_display_number` string — Invoice number to be displayed to the customer
  - `mercid` string — Unique identifier as defined by BillDesk for each merchant
  - `subscription_refid` string — Unique reference assigned by merchant for a subscription
  - `customer_refid` string — Unique reference of the customer in the merchant system, and can be linked to different subscriptions of the same customer Required for mandate and tokenization
  - `invoice_date` string, date — Invoice generation date in the YYYYMMDD format
  - `duedate` string, date — Invoice due date in the YYYYMMDD format
  - `debit_date` string, date — Date on which the SI debit needs to be executed to the payment method
  - `amount` string — Invoice amount in two decimals, eg. 2400.00
  - `net_amount` string — Current payable amount, adjusted for discount or late payment charges as applicable
  - `early_payment_due_date` string, date — Early payment date for invoice
  - `early_payment_discount` string — Discount amount for early payment of invoice
  - `early_payment_amount` string — Amount after adjusting any discount applicable.
  - `late_payment_charges` string — Late payment charges if any
  - `late_payment_amount` string — Payment amount after due date
  - `currency` string — ISO currency of the transaction amount, for INR this value will be 356
  - `mandateid` string — Unique mandateid created by BillDesk
  - `description` string — Brief description for the invoice
  - `status` 'unpaid' | 'rejected' | 'stopped' — Status of the invoice. Possible values are: • unpaid – invoice has been received successfully, and charge can be processed • rejected – invoice has been rejected by the system • stopped – invoice has been stopped by the customer
  - `invoice_id` string — Unique id created by BillDesk for each invoice
  - `verification_error_code` string — Represents the error code for the response
  - `verification_error_type` string — Represents the error type for the response
  - `verification_error_desc` string — Represents the error description for the response
  - `createdon` string, date-time — object creation timestamp
  - `debit_request_no` string — Sequence of the recurring charge as per the mandate received from the customer For e.g. Say a customer is on a monthly payment plan – the first recurring charge has the value as “1”, the second as “2” and so on. If the merchant does not process a debit say for the second month and then in the next (third) month when initiating a charge, this value should be set as “3” in the request.
  - `additional_info` AdditionalInfo — Array of 7 additional_info values that can be attached to the transaction. Note: Merchant is advised to not pass customer PII information in additional info fields.
    - `additional_info1` string
    - `additional_info2` string
    - `additional_info3` string
    - `additional_info4` string
    - `additional_info5` string
    - `additional_info6` string
    - `additional_info7` string

## Other responses

- `403` — Forbidden
- `500` — Internal Server Error
- `default` — Any bad or invalid request will lead to following error object

---

[API](https://skmtc.net/billdesk/apis/payments.md) · [All operations](https://skmtc.net/billdesk/apis/payments/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/billdesk/payments/revisions/43f021fc467f/schema)
