Payink API documentation
Search…
PAYINK Web API - overview
Add a customer
Update customer
Add Matter (Invoice)
Update Matter (Invoice)
Delete Matter (Invoice)
Upload invoice file
Upload credit note
Send invoice
Get single invoice/matter status
Get multiple invoices/matters statuses
Webhooks
Embedded / Hosted payment page
List of supported countries
Glossary
Version Control
Powered By GitBook
Get multiple invoices/matters statuses
Use this web method to get multiple invoice/matter payment statuses
get
https://testclient.payink.com
/api/matters?customerName=&fromDueDate=&toDueDate
Get multiple invoices/matters statuses (STAGE)

Request example by "customerName"

(e.g. customerName = "Payink LTD")
1
{
2
"message": null,
3
"status": "success",
4
"data": [
5
{
6
"practice_area": "Audit",
7
"bill_amount": 8.00,
8
"due_date": "2021-05-31",
9
"customer_number": "Pay123",
10
"invoice_date": 2021-05-20,
11
"matter_number": "Pay1000",
12
"payment_status": "COLLECTED"
13
"customer": "Payink LTD"
14
},
15
{
16
"practice_area": "Notary Services",
17
"bill_amount": 15.00,
18
"due_date": "2021-05-19",
19
"customer_number": "Pay123",
20
"invoice_date": 2021-05-19,
21
"matter_number": "Pay2000",
22
"payment_status": "NOT_DUE"
23
"customer": "Payink LTD"
24
},
25
{
26
"practice_area": "Transfer Pricing Advisory",
27
"bill_amount": 20.00,
28
"due_date": "2021-06-18",
29
"customer_number": "Pay123",
30
"invoice_date": 2021-05-15,
31
"matter_number": "PAY3000",
32
"payment_status": "COLLECTED"
33
"customer": "Payink LTD"
34
},
35
{
36
"practice_area": "Annual Management",
37
"bill_amount": 10.00,
38
"due_date": "2021-05-18",
39
"customer_number": "Pay123",
40
"invoice_date": 2021-05-18,
41
"matter_number": "Pay4000",
42
"payment_status": "OVER_DUE"
43
"customer": "Payink LTD"
44
}
45
]
46
}
Copied!

Request example by "fromDueDate" + "toDueDate"

(e.g. fromDueDate = 2021-05-21 ; toDueDate = 2021-05-23)
1
{
2
"message": null,
3
"status": "success",
4
"data": [
5
{
6
"practice_area": "Audit",
7
"bill_amount": 9.00,
8
"due_date": "2021-05-21",
9
"customer_number": "Pay123",
10
"invoice_date": 2021-05-20,
11
"matter_number": "Pay1001",
12
"payment_status": "COLLECTED"
13
"customer": "Payink LTD"
14
},
15
{
16
"practice_area": "Notary Services",
17
"bill_amount": 16.00,
18
"due_date": "2021-05-22",
19
"customer_number": "Buy123",
20
"invoice_date": 2021-05-19,
21
"matter_number": "Buy1001",
22
"payment_status": "NOT_DUE"
23
"customer": "Buyink LTD"
24
},
25
{
26
"practice_area": "Annual Management",
27
"bill_amount": 11.00,
28
"due_date": "2021-05-23",
29
"customer_number": "Get123",
30
"invoice_date": 2021-05-18,
31
"matter_number": "Get1001",
32
"payment_status": "OVER_DUE"
33
"customer": "Getink LTD"
34
}
35
]
36
}
Copied!

Request example by "customerName" + "fromDueDate" + "toDueDate"

(e.g. customerName = "Payink LTD" ; fromDueDate = 2021-05-18 ; toDueDate = 2021-05-19)
1
{
2
"message": null,
3
"status": "success",
4
"data": [
5
{
6
"practice_area": "Notary Services",
7
"bill_amount": 15.00,
8
"due_date": "2021-05-19",
9
"customer_number": "Pay123",
10
"invoice_date": 2021-05-19,
11
"matter_number": "Pay2000",
12
"payment_status": "NOT_DUE"
13
"customer": "Payink LTD"
14
},
15
{
16
"practice_area": "Annual Management",
17
"bill_amount": 10.00,
18
"due_date": "2021-05-18",
19
"customer_number": "Pay123",
20
"invoice_date": 2021-05-18,
21
"matter_number": "Pay4000",
22
"payment_status": "OVER_DUE"
23
"customer": "Payink LTD"
24
}
25
]
26
}
Copied!
get
https://client.payink.com
/api/matters?customerName=&fromDueDate=&toDueDate
Get multiple invoices/matters statuses (PRODUCTION)

Request example by "customerName"

(e.g. customerName = "Payink LTD")
1
{
2
"message": null,
3
"status": "success",
4
"data": [
5
{
6
"practice_area": "Audit",
7
"bill_amount": 8.00,
8
"due_date": "2021-05-31",
9
"customer_number": "Pay123",
10
"invoice_date": 2021-05-20,
11
"matter_number": "Pay1000",
12
"payment_status": "COLLECTED"
13
"customer": "Payink LTD"
14
},
15
{
16
"practice_area": "Notary Services",
17
"bill_amount": 15.00,
18
"due_date": "2021-05-19",
19
"customer_number": "Pay123",
20
"invoice_date": 2021-05-19,
21
"matter_number": "Pay2000",
22
"payment_status": "NOT_DUE"
23
"customer": "Payink LTD"
24
},
25
{
26
"practice_area": "Transfer Pricing Advisory",
27
"bill_amount": 20.00,
28
"due_date": "2021-06-18",
29
"customer_number": "Pay123",
30
"invoice_date": 2021-05-15,
31
"matter_number": "PAY3000",
32
"payment_status": "COLLECTED"
33
"customer": "Payink LTD"
34
},
35
{
36
"practice_area": "Annual Management",
37
"bill_amount": 10.00,
38
"due_date": "2021-05-18",
39
"customer_number": "Pay123",
40
"invoice_date": 2021-05-18,
41
"matter_number": "Pay4000",
42
"payment_status": "OVER_DUE"
43
"customer": "Payink LTD"
44
}
45
]
46
}
Copied!

Request example by "fromDueDate" + "toDueDate"

(e.g. fromDueDate = 2021-05-21 ; toDueDate = 2021-05-23)
1
{
2
"message": null,
3
"status": "success",
4
"data": [
5
{
6
"practice_area": "Audit",
7
"bill_amount": 9.00,
8
"due_date": "2021-05-21",
9
"customer_number": "Pay123",
10
"invoice_date": 2021-05-20,
11
"matter_number": "Pay1001",
12
"payment_status": "COLLECTED"
13
"customer": "Payink LTD"
14
},
15
{
16
"practice_area": "Notary Services",
17
"bill_amount": 16.00,
18
"due_date": "2021-05-22",
19
"customer_number": "Buy123",
20
"invoice_date": 2021-05-19,
21
"matter_number": "Buy1001",
22
"payment_status": "NOT_DUE"
23
"customer": "Buyink LTD"
24
},
25
{
26
"practice_area": "Annual Management",
27
"bill_amount": 11.00,
28
"due_date": "2021-05-23",
29
"customer_number": "Get123",
30
"invoice_date": 2021-05-18,
31
"matter_number": "Get1001",
32
"payment_status": "OVER_DUE"
33
"customer": "Getink LTD"
34
}
35
]
36
}
Copied!

Request example by "customerName" + "fromDueDate" + "toDueDate"

(e.g. customerName = "Payink LTD" ; fromDueDate = 2021-05-18 ; toDueDate = 2021-05-19)
1
{
2
"message": null,
3
"status": "success",
4
"data": [
5
{
6
"practice_area": "Notary Services",
7
"bill_amount": 15.00,
8
"due_date": "2021-05-19",
9
"customer_number": "Pay123",
10
"invoice_date": 2021-05-19,
11
"matter_number": "Pay2000",
12
"payment_status": "NOT_DUE"
13
"customer": "Payink LTD"
14
},
15
{
16
"practice_area": "Annual Management",
17
"bill_amount": 10.00,
18
"due_date": "2021-05-18",
19
"customer_number": "Pay123",
20
"invoice_date": 2021-05-18,
21
"matter_number": "Pay4000",
22
"payment_status": "OVER_DUE"
23
"customer": "Payink LTD"
24
}
25
]
26
}
Copied!
Previous
Get single invoice/matter status
Next
Webhooks
Last modified 7mo ago
Copy link
Contents
get
Get multiple invoices/matters statuses (STAGE)
get
Get multiple invoices/matters statuses (PRODUCTION)