Fetch All Debit Notes

GET

/apis/external/vendor/debitNote/getAllDebitNotes

GET

/apis/external/vendor/debitNote/getAllDebitNotes

$ curl -G https://heimdall.eka.io/apis/external/vendor/debitNote/getAllDebitNotes \
>      -H "DICE-APP-ID: {{Company Code}}" \
>      -H "X-CLIENT-ID: {{API Client ID}}" \
>      -H "X-CLIENT-SECRET: {{API Client Secret}}" \
>      -d endDate=1707417000000 \
>      -d offset=0 \
>      -d startDate=1707217922000

200Debit Note_Fetch All Debit Notes_example

1 {
2   "debitNotes": [
3     {
4       "id": 103,
5       "debitNoteId": "DN-INDIAN-000000015",
6       "billNo": "# 674854\ncreated on 30/01/2024",
7       "date": 1707417000000,
8       "createdAt": 1707469470938,
9       "updatedAt": 1707469470962,
10       "amount": 608.96,
11       "currencyAmount": 608.96,
12       "currency": "INR",
13       "stage": "start",
14       "status": "COMPLETED",
15       "service": "karan",
16       "category": "karan",
17       "categoryId": 129,
18       "owner": {
19         "id": 118,
20         "ownerType": "ADMIN",
21         "ownerId": "118",
22         "ownerName": "Admin"
23       },
24       "invoice": {
25         "id": 469761,
26         "invoiceId": "VI-INDIAN-000001961",
27         "amount": 1254.64,
28         "currencyAmount": 1254.64,
29         "owner": {
30           "id": 17253,
31           "ownerType": "EMPLOYEE",
32           "ownerId": "0001",
33           "ownerName": "karanss kumar"
34         },
35         "status": "CREDIT_NOTE_HOLD",
36         "date": 1707417000000,
37         "dueDate": 1708281000000,
38         "createdAt": 1707469364441
39       },
40       "vendor": {
41         "id": 231492,
42         "registeredId": "test",
43         "name": "SKPL ANTREPRIZ SOLUTIONS PRIVATE LIMITED",
44         "tradeName": "SKPL ANTREPRIZ SOLUTIONS PRIVATE LIMITED",
45         "pan": "AAZCS7239P",
46         "rcVendor": false
47       },
48       "officeData": {
49         "id": 1346,
50         "name": "Mumbaij",
51         "address": "wlidjfsdf"
52       }
53     },
54     {
55       "id": 102,
56       "debitNoteId": "DN-INDIAN-000000014",
57       "billNo": "54cghj",
58       "date": 1707330600000,
59       "createdAt": 1707469399133,
60       "updatedAt": 1707469399156,
61       "amount": 10,
62       "currencyAmount": 10,
63       "currency": "INR",
64       "stage": "start",
65       "status": "COMPLETED",
66       "service": "karan",
67       "category": "karan",
68       "categoryId": 129,
69       "owner": {
70         "id": 118,
71         "ownerType": "ADMIN",
72         "ownerId": "118",
73         "ownerName": "Admin"
74       },
75       "invoice": {
76         "id": 468802,
77         "invoiceId": "VI-INDIAN-000001955",
78         "amount": 21,
79         "currencyAmount": 21,
80         "owner": {
81           "id": 434030,
82           "ownerType": "EMPLOYEE",
83           "ownerId": "e0099",
84           "ownerName": "srinivas ss"
85         },
86         "status": "PENDING",
87         "date": 1707330600000,
88         "dueDate": 1707330600000,
89         "createdAt": 1707382269131
90       },
91       "vendor": {
92         "id": 287032,
93         "registeredId": "CONTACT-INDIAN-0000063",
94         "name": "BAKKIREDDY SRINIVASULU REDDY",
95         "tradeName": "TDTRFG",
96         "pan": " AFQPA7358J",
97         "rcVendor": false
98       },
99       "officeData": {
100         "id": 1347,
101         "name": "Pune",
102         "address": "string"
103       }
104     },
105     {
106       "id": 101,
107       "debitNoteId": "DN-INDIAN-000000013",
108       "billNo": "gfdxxfcghbn",
109       "date": 1707417000000,
110       "createdAt": 1707468980330,
111       "updatedAt": 1707468980357,
112       "amount": 118,
113       "currencyAmount": 118,
114       "currency": "INR",
115       "stage": "start",
116       "status": "COMPLETED",
117       "service": "karan",
118       "category": "karan",
119       "categoryId": 129,
120       "owner": {
121         "id": 118,
122         "ownerType": "ADMIN",
123         "ownerId": "118",
124         "ownerName": "Admin"
125       },
126       "invoice": {
127         "id": 469600,
128         "invoiceId": "VI-INDIAN-000001960",
129         "amount": 14160,
130         "currencyAmount": 14160,
131         "owner": {
132           "id": 434030,
133           "ownerType": "EMPLOYEE",
134           "ownerId": "e0099",
135           "ownerName": "srinivas ss"
136         },
137         "status": "CREDIT_NOTE_HOLD",
138         "date": 1707417000000,
139         "dueDate": 1707417000000,
140         "createdAt": 1707464232504
141       },
142       "vendor": {
143         "id": 287032,
144         "registeredId": "CONTACT-INDIAN-0000063",
145         "name": "BAKKIREDDY SRINIVASULU REDDY",
146         "tradeName": "TDTRFG",
147         "pan": " AFQPA7358J",
148         "rcVendor": false
149       },
150       "officeData": {
151         "id": 1347,
152         "name": "Pune",
153         "address": "string"
154       }
155     },
156     {
157       "id": 100,
158       "debitNoteId": "DN-INDIAN-000000012",
159       "billNo": "14",
160       "date": 1707417000000,
161       "createdAt": 1707464911844,
162       "updatedAt": 1707464911864,
163       "amount": 12,
164       "currencyAmount": 12,
165       "currency": "INR",
166       "stage": "start",
167       "status": "COMPLETED",
168       "service": "karan",
169       "category": "karan",
170       "categoryId": 129,
171       "owner": {
172         "id": 118,
173         "ownerType": "ADMIN",
174         "ownerId": "118",
175         "ownerName": "Admin"
176       },
177       "invoice": {
178         "id": 469434,
179         "invoiceId": "VI-INDIAN-000001958",
180         "amount": 133,
181         "currencyAmount": 133,
182         "owner": {
183           "id": 287032,
184           "ownerType": "CONTACT",
185           "ownerId": "287032",
186           "ownerName": "BAKKIREDDY SRINIVASULU REDDY"
187         },
188         "status": "CREDIT_NOTE_HOLD",
189         "date": 1707417000000,
190         "dueDate": 1707417000000,
191         "createdAt": 1707459075806
192       },
193       "vendor": {
194         "id": 287032,
195         "registeredId": "CONTACT-INDIAN-0000063",
196         "name": "BAKKIREDDY SRINIVASULU REDDY",
197         "tradeName": "TDTRFG",
198         "pan": " AFQPA7358J",
199         "rcVendor": false
200       },
201       "officeData": {
202         "id": 1347,
203         "name": "Pune",
204         "address": "string"
205       }
206     },
207     {
208       "id": 99,
209       "debitNoteId": "DN-INDIAN-000000011",
210       "billNo": "14",
211       "date": 1707417000000,
212       "createdAt": 1707464889072,
213       "updatedAt": 1707464889108,
214       "amount": 16,
215       "currencyAmount": 16,
216       "currency": "INR",
217       "stage": "start",
218       "status": "COMPLETED",
219       "service": "karan",
220       "category": "karan",
221       "categoryId": 129,
222       "owner": {
223         "id": 118,
224         "ownerType": "ADMIN",
225         "ownerId": "118",
226         "ownerName": "Admin"
227       },
228       "invoice": {
229         "id": 469434,
230         "invoiceId": "VI-INDIAN-000001958",
231         "amount": 133,
232         "currencyAmount": 133,
233         "owner": {
234           "id": 287032,
235           "ownerType": "CONTACT",
236           "ownerId": "287032",
237           "ownerName": "BAKKIREDDY SRINIVASULU REDDY"
238         },
239         "status": "CREDIT_NOTE_HOLD",
240         "date": 1707417000000,
241         "dueDate": 1707417000000,
242         "createdAt": 1707459075806
243       },
244       "vendor": {
245         "id": 287032,
246         "registeredId": "CONTACT-INDIAN-0000063",
247         "name": "BAKKIREDDY SRINIVASULU REDDY",
248         "tradeName": "TDTRFG",
249         "pan": " AFQPA7358J",
250         "rcVendor": false
251       },
252       "officeData": {
253         "id": 1347,
254         "name": "Pune",
255         "address": "string"
256       }
257     },
258     {
259       "id": 98,
260       "debitNoteId": "DN-INDIAN-000000010",
261       "billNo": "14",
262       "date": 1707417000000,
263       "createdAt": 1707462112971,
264       "updatedAt": 1707464911859,
265       "amount": 60,
266       "currencyAmount": 60,
267       "currency": "INR",
268       "stage": "start",
269       "status": "COMPLETED",
270       "service": "karan",
271       "category": "karan",
272       "categoryId": 129,
273       "owner": {
274         "id": 118,
275         "ownerType": "ADMIN",
276         "ownerId": "118",
277         "ownerName": "Admin"
278       },
279       "invoice": {
280         "id": 469434,
281         "invoiceId": "VI-INDIAN-000001958",
282         "amount": 133,
283         "currencyAmount": 133,
284         "owner": {
285           "id": 287032,
286           "ownerType": "CONTACT",
287           "ownerId": "287032",
288           "ownerName": "BAKKIREDDY SRINIVASULU REDDY"
289         },
290         "status": "CREDIT_NOTE_HOLD",
291         "date": 1707417000000,
292         "dueDate": 1707417000000,
293         "createdAt": 1707459075806
294       },
295       "vendor": {
296         "id": 287032,
297         "registeredId": "CONTACT-INDIAN-0000063",
298         "name": "BAKKIREDDY SRINIVASULU REDDY",
299         "tradeName": "TDTRFG",
300         "pan": " AFQPA7358J",
301         "rcVendor": false
302       },
303       "officeData": {
304         "id": 1347,
305         "name": "Pune",
306         "address": "string"
307       }
308     }
309   ],
310   "total": 6,
311   "currentPage": 0,
312   "totalPages": 1
313 }

Fetch All Debit Notes

This endpoint is a GET request to retrieve All Debit Notes based on the given time stamp.

Request Parameters

This API is use to get all Invoices existing in Dice.

Params	Required	Description
start_date	Mandatory	Date filter, from which date Debit notes needs to be fetched. Format - Unix timestamp
end_date	Mandatory	Date filter, till which date the Debit notes need to be fetched. Format - Unix timestamp
offset	Mandatory	Page Number

**Fetch All Debit Notes** This endpoint is a GET request to retrieve All Debit Notes based on the given time stamp. ### Request Parameters This API is use to get all Invoices existing in Dice. | **Params** | **Required** | **Description** | | --- | --- | --- | | start_date | Mandatory | Date filter, from which date Debit notes needs to be fetched. <br> <br>Format - Unix timestamp | | end_date | Mandatory | Date filter, till which date the Debit notes need to be fetched. <br> <br>Format - Unix timestamp | | offset | Mandatory | Page Number |

Query parameters

startDateintegerOptional

Start date (unix timestamp) for filtering credit notes.

endDateintegerOptional

Start date (unix timestamp) for filtering credit notes.

offsetintegerOptional

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

Response

debitNoteslist of objects

totalinteger

currentPageinteger

totalPagesinteger

Request Parameters

Headers

Query parameters

Response

Request Parameters