curl --request POST \
--url https://sandbox-platform.jupico.com/v1/query/invoices \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '{}'import requests
url = "https://sandbox-platform.jupico.com/v1/query/invoices"
payload = {}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({})
};
fetch('https://sandbox-platform.jupico.com/v1/query/invoices', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const url = 'https://sandbox-platform.jupico.com/v1/query/invoices';
const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({})
};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));{
"success": true,
"code": "<string>",
"count": 123,
"data": [
{
"spProductId": "<string>",
"subMerchantId": "<string>",
"customerId": "<string>",
"invoiceId": "<string>",
"invoiceNumber": "<string>",
"date": "2023-11-07T05:31:56Z",
"paymentTerm": "<string>",
"dueDate": "2023-11-07T05:31:56Z",
"items": [
{
"description": "<string>",
"quantity": 123,
"amount": 123,
"_id": "<string>"
}
],
"totalAmount": 123,
"status": "<string>",
"isSent": true,
"isViewed": true,
"logs": [
{
"message": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"metadata": {
"transactionId": "<string>"
}
}
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"query": {
"criteria": {},
"options": {}
}
}List invoices
Returns invoices with amounts, statuses, and associated customers and submerchants.
curl --request POST \
--url https://sandbox-platform.jupico.com/v1/query/invoices \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '{}'import requests
url = "https://sandbox-platform.jupico.com/v1/query/invoices"
payload = {}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({})
};
fetch('https://sandbox-platform.jupico.com/v1/query/invoices', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const url = 'https://sandbox-platform.jupico.com/v1/query/invoices';
const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({})
};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));{
"success": true,
"code": "<string>",
"count": 123,
"data": [
{
"spProductId": "<string>",
"subMerchantId": "<string>",
"customerId": "<string>",
"invoiceId": "<string>",
"invoiceNumber": "<string>",
"date": "2023-11-07T05:31:56Z",
"paymentTerm": "<string>",
"dueDate": "2023-11-07T05:31:56Z",
"items": [
{
"description": "<string>",
"quantity": 123,
"amount": 123,
"_id": "<string>"
}
],
"totalAmount": 123,
"status": "<string>",
"isSent": true,
"isViewed": true,
"logs": [
{
"message": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"metadata": {
"transactionId": "<string>"
}
}
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"query": {
"criteria": {},
"options": {}
}
}Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Body
The body is of type object.
Response
Find Invoices
Whether the request was processed successfully. Declines return HTTP 200 with success: false.
Machine-readable result code. See the Error Codes reference.
Number of records.
The response payload.
Hide child attributes
Hide child attributes
Identifier of the Service Provider product the merchant belongs to.
Unique identifier of the submerchant.
Unique identifier of the customer.
Unique identifier of the invoice.
Invoice number displayed to the customer.
Invoice issue date (ISO 8601).
Payment terms shown on the invoice (for example, Due Upon Receipt).
Date payment is due (ISO 8601).
The total amount.
Current status.
Whether the invoice has been sent.
Whether the customer viewed the invoice.
Event log entries.
Hide child attributes
Hide child attributes
Human-readable result message.
Timestamp when the object was created (ISO 8601).
Timestamp when the object was created (ISO 8601).
Timestamp when the object was last updated (ISO 8601).
Was this page helpful?

