Fetch Invoices API

View as Markdown
### Fetch Invoices API This API is use to get all Invoices existing in Dice. | **Params** | **Required** | **Description** | | --- | --- | --- | | start_date | Mandatory | Date filter, from which date the Invoices needs to be fetched. <br> <br>Format - **dd-MM-yyyy** | | end_date | Mandatory | Date filter, till which date the Invoices need to be fetched. <br> <br>Format - **dd-MM-yyyy** | | offset | Mandatory | Page Number | | pageSize | Optional | Number of Invoices to be fetched in a single page. Value cannot be greater than 5000. <br> <br>If not provided along with the request then default value will be 1000 considered. | | status | Optional | Status of Invoice. <br>filter - settlement_pending / settled / completed |

Headers

DICE-APP-IDstringOptional
Company Code of client
X-CLIENT-IDstringOptional
API Client ID
X-CLIENT-SECRETstringOptional
API Client Secret
statusstringOptional
Status of Invoice

Query parameters

start_datestringOptional

Date should be in dd-MM-yyyy format and it runs on CreatedAt

end_datestringOptional

Date should be in dd-MM-yyyy format and it runs on CreatedAt

offsetintegerOptional

Offset starts from 0 (Page Number), values can be 0, 1, 2

pageSizeintegerOptional
optinal parameter, default is 1000

Response

OK
invoiceslist of objects
totalinteger
currentPageinteger
totalPagesinteger