Search Invoices

Retrieve list of invoices based on search criteria.

Request

Security:

Bearer

path Parameters

version

required

string

Request Body schema: application/json

InvoiceSearchRequest

limit	integer <int32> [ 1 .. 1000 ] Limit number of invoices to retrieve (Will be defaulted to 100 if none specified)
start_index	integer or null <int32> [ 1 .. 1000 ] Index used for pagination of the result
program_guid required	string <uuid> Unique Program Identifier on Qolo Platform.
payee_person_guid	string or null <uuid> Unique Payee person identifier on Qolo Platform.
card_proxy	string or null [ 1 .. 19 ] characters Card proxy
card_number	string or null [ 1 .. 19 ] characters Card number
	object (InvoiceDetailsSearchRequest)

Responses

200

Returns the invoices

400

Bad request

401

Unauthorized

500

Server Error

post/api/{version}/cards/invoices/search

Request samples

Payload
curl
JavaScript
Node.js

application/json

{"limit": 1,
"start_index": 1,
"program_guid": "3fa0d2ea-ffcf-485d-94ed-dbf4f861ad2f",
"payee_person_guid": "48cda763-01cd-48bf-a089-8e540940a476",
"card_proxy": "string",
"card_number": "string",
"invoice_details": {"min_invoice_date": "2019-08-24T14:15:22Z",
"max_invoice_date": "2019-08-24T14:15:22Z",
"invoice_status": "string",
"invoice_number": "string",
"min_invoice_amount": 0,
"max_invoice_amount": 0,
"invoice_description": "string"
}
}

Response samples

application/json

{"count": 0,
"start_index": 0,
"end_index": 0,
"has_more": true,
"data": [{"person_guid": "2ae6ba4b-f6c0-4817-a158-43e5a87168fd",
"first_name": "string",
"last_name": "string",
"card_proxy": "string",
"mask_card_pan": "string",
"invoice_details": [{"invoice_number": "string",
"invoice_date": "2019-08-24T14:15:22Z",
"invoice_amount": 0,
"payment_description": "string",
"payment_status": "ACTIVE",
"sys_utcupdated": "2019-08-24T14:15:22Z"
}
]
}
],
"check_statuses": ["string"
]
}