Get all invoice issue by the Merchant (owner of the account)
This endpoint needs your API key
Send it as a bearer token in the Authorization header. A request without one is answered with 401. See Authentication for where to find your key and how to keep it secret.
Request
curl -X GET "https://api.leapa.co/v2/invoices/email/jeanne@example.com?pageFilter=<pageFilter>" \
-H "Authorization: Bearer $LEAPA_API_KEY" \
-H "Accept: application/json"Response
OK
{
"page": 0,
"size": 0,
"total_elements": 0,
"total_pages": 0,
"data": [
{
"id": "obj_5f21c8a40b",
"object": "string",
"customer": {
"id": null,
"object": null,
"email": null,
"address": null,
"status": null,
"first_name": null,
"last_name": null,
"birth_date": null,
"phone_number": null,
"merchant_name": null,
"merchant_id": null,
"sources": null,
"destinations": null,
"live": null,
"reference_id": null
},
"currency": "BIF",
"description": "Room 204, two nights",
"sendForManualPayment": false,
"automatic": false,
"pdfLink": "string",
"number": "string",
"products": [],
"sent_count": 1,
"statement_descriptor": "string",
"issue_date": 0,
"due_date": 0,
"amount": 45000,
"amount_due": 45000,
"discount_amount": 45000,
"status": "draft",
"charge": {
"id": null,
"object": null,
"amount": null,
"currency": null,
"description": null,
"status": null,
"source": null,
"affiliate": null,
"amount_refunded": null,
"available_date": null,
"captured": null,
"created_date": null,
"disputed": null,
"failure_code": null,
"failure_message": null,
"invoice_id": null,
"live": null,
"modified_date": null,
"refunded": null,
"customer_id": null,
"processing_id": null,
"quittance_number": null
},
"charges": [],
"type": "bank",
"url": "string",
"pdf_url": "string",
"source_id": "src_0e7b3c95af",
"manual_payment": false,
"merchant": {
"id": null,
"object": null,
"url": null,
"currency": null,
"name": null,
"legal_name": null,
"tax_id": null,
"phone_number": null,
"email": null,
"registration_id": null,
"statement_descriptor": null,
"description": null,
"support_url": null,
"time_zone": null,
"type": null,
"address": null,
"balance_available": null,
"balance_pending": null,
"status": null
},
"live": false,
"reference_id": "ref_9f2a17c4",
"rate_id": "rat_20b6df3c9e",
"total_amount_paid": 45000,
"charge_ids": [],
"quittance_number": "string"
}
]
}Path parameters
Values that go into the URL itself.
emailstringrequiredExample:jeanne@example.com
Query parameters
Appended to the URL after a `?`.
pageFilterPageFilterrequired
Response
pageinteger<int32>Current page number.
sizeinteger<int32>Number of element in a page.
total_elementsinteger<int64>Total Elements.
total_pagesinteger<int64>The total Pages.
dataarray of InvoiceResponseList of invoices.
idstringGenerated Invoice Id by the system
objectstringInvoice object.
customerCustomerResponseidstringCustomer Unique ID
objectstringCustomer - Object Returned
emailstringCustomer email
addressAddressResponseobjectstringObject name
citystringCity
typestringThe type of address. Can be Business location address or Bank Address
Allowed values:personalbusinessstatusstringAddress status - invalid, line1_fail, line1_pass, line1_zip_pass, unchecked, verified, zip_fail, zip_pass
Allowed values:invalidline1_passline1_name_passline1_zip_passname_passname_zip_passuncheckedverifiedand 1 morestatestringState
zipstringZip
line1stringLine 1
line2stringLine 2
statusstringCustomer Status
Allowed values:activedeactivatedeletedfirst_namestringCustomer firstname
last_namestringCustomer lastname
birth_datestringCustomer birthdate
phone_numberstringCustomer phone number
merchant_namestringMerchant name associated to this Customer
merchant_idstringMerchant ID associated to this Customer
sourcesarray of AccountCustomerSourceReferenceResponseList of all Account Reference source of the customer
fingerprintstringUnique identifier of the card. Two accountId with the same fingerprint is the same card
currencystringCurrency Code.
Allowed values:BIFUSDKESXAFtypestringAccount Type
Allowed values:bankbalancecardfeesmobilewalletcashipsaccount_idstringAccount Id of the customer
defaultbooleanFlag indicating whether it is a default card or not.
destinationsarray of AccountCustomerDestinationReferenceResponseList of all Account Reference destination of the customer
currencystringCurrency Code.
Allowed values:BIFUSDKESXAFtypestringAccount Type
Allowed values:bankbalancecardfeesmobilewalletcashipsaccount_idstringAccount Id of the customer
default_destinationboolean
livebooleanWhether the object exist in live or test mode.
reference_idstringReference Id
currencystringCurrency of the amount in the invoice.
Allowed values:BIFUSDKESXAFdescriptionstringDescription of the invoice.
sendForManualPaymentbooleanautomaticbooleanpdfLinkstringnumberstringInvoice Number in a readable version for the user.
productsarray of ItemResponseList of product and quantity.
objectstringName of the object
productProductResponseidstringProduct ID
namestringProduct Name
codestringProduct Code
descriptionstringProduct Description
statusstringProduct Status
Allowed values:soldoutavailableunavailabletypestringProduct type
Allowed values:servicegoodaddonstandardsingletriplequadsuiteand 10 moreimagesarray of stringList of images URL of the product
attributesProductAttributerateIdarray of stringcreated_dateinteger<int64>Product creation time
price_detailsarray of PriceDetailResponseDetail of the price
livebooleanWhether is the production data or test data.
rate_idsarray of stringRate Id that will affect the product price.
quantityinteger<int64>Quantity billed in the invoice
pricenumber<double>Price that the merchant will give to this product at the moment of the purchase.
rate_idsarray of stringRateIds
discounted_pricenumber<double>Price with applied rate, if there are any rates applied
adjusted_priceinteger<int64>Price that the merchant will give to this product at the moment of the purchase.
sent_countinteger<int32>Number of time the invoice has been send to the customer for payment.
statement_descriptorstringStatement Descriptor of the Merchant. This is a readOnly data.
issue_dateinteger<int64>Invoice issue date.
due_dateinteger<int64>Invoice due date.
amountinteger<int64>Initial payment request amount to the customer for the service or product of the merchant.
amount_dueinteger<int64>Remaining amount due in order to clear this Invoice.
discount_amountinteger<int64>Amount of discount applied to the invoice.
statusstringStatus of the invoices: Draft, Pending, Paid, Void
Allowed values:draftpendingsentpaidpartial_paidvoidedoverduerefundedchargeChargeResponseidstringobjectstringamountinteger<int64>currencystringAllowed values:BIFUSDKESXAFdescriptionstringstatusstringAllowed values:succeededpaidpendingfailedsourceSourceObjectidstringSource id
brandstringPayment Method Brand Name: Either Mastercard, Visa or Ecocash(Mobile Money)
Allowed values:ecocashlumicashmastercardvisafundingstringCard funding type. Either credit, debit, prepaid, or unknown
Allowed values:creditdebitprepaidunknownlast4stringLast Four ditgits of the card
emailstringEmail of the card Owner.
fingerprintstringUnique identifier of the card number as returned by the CyberSource TMS API
tokenstringUnique identifier of the card data as returned by the CyberSource TMS API
languagestringPrefered Language of the Customer. Used for Mobile Money.
numberstringThe mobile money number.
cvc_checkstringCard Verification Code check result
Allowed values:passfailunavailableuncheckedexp_monthstringTwo digit number representing the expiration number
exp_yearstringFour digit number representing the expiration date
statement_descriptorstringProvides information about the charge that customers see on their statements. Maximum 22 characters.
country_codestringCountry Code, needed when the Payment Method is Mobile Money.
affiliatestringAllowed values:dwelinnamount_refundedinteger<int64>available_dateinteger<int64>capturedbooleancreated_dateinteger<int64>disputedbooleanfailure_codestringfailure_messagestringinvoice_idstringlivebooleanmodified_dateinteger<int64>refundedbooleancustomer_idstringprocessing_idstringquittance_numberstring
chargesarray of ChargeResponseInvoice Charges
idstringobjectstringamountinteger<int64>currencystringAllowed values:BIFUSDKESXAFdescriptionstringstatusstringAllowed values:succeededpaidpendingfailedsourceSourceObjectidstringSource id
brandstringPayment Method Brand Name: Either Mastercard, Visa or Ecocash(Mobile Money)
Allowed values:ecocashlumicashmastercardvisafundingstringCard funding type. Either credit, debit, prepaid, or unknown
Allowed values:creditdebitprepaidunknownlast4stringLast Four ditgits of the card
emailstringEmail of the card Owner.
fingerprintstringUnique identifier of the card number as returned by the CyberSource TMS API
tokenstringUnique identifier of the card data as returned by the CyberSource TMS API
languagestringPrefered Language of the Customer. Used for Mobile Money.
numberstringThe mobile money number.
cvc_checkstringCard Verification Code check result
Allowed values:passfailunavailableuncheckedexp_monthstringTwo digit number representing the expiration number
exp_yearstringFour digit number representing the expiration date
statement_descriptorstringProvides information about the charge that customers see on their statements. Maximum 22 characters.
country_codestringCountry Code, needed when the Payment Method is Mobile Money.
affiliatestringAllowed values:dwelinnamount_refundedinteger<int64>available_dateinteger<int64>capturedbooleancreated_dateinteger<int64>disputedbooleanfailure_codestringfailure_messagestringinvoice_idstringlivebooleanmodified_dateinteger<int64>refundedbooleancustomer_idstringprocessing_idstringquittance_numberstring
typestringCharge Account Type for Payment
Allowed values:bankbalancecardfeesmobilewalletcashipsurlstringInvoice url
pdf_urlstringUrl link to download the PDF file of the invoice.
source_idstringCustomer existing source information.
manual_paymentbooleanSend invoice via email for manual payments.
merchantMerchantProfileResponseidstringMerchant Unique ID
objectstringReturn Object Name
urlstringOptional field that describe the website URL of your business.
currencystringCurrency Code
Allowed values:BIFUSDKESXAFnamestringBusiness Name
legal_namestringLegal Business Name
tax_idstringTax Id of the business
phone_numberstringemailstringregistration_idstringCommerce Reg Number
statement_descriptorstringStatement Description
descriptionstringSmall description of your Goods or Services. Constraint: Not null, Not blank, size(5-22)
support_urlstringOptional field that describe the website URL of the support pages.
time_zonestringTime Zone of Merchant
Allowed values:AFRICA_BUJUMBURAAFRICA_DOUALAAFRICA_NAIROBItypestringHolder Type
Allowed values:individualcompanyaddressAddressResponseAccountobjectstringObject name
citystringCity
typestringThe type of address. Can be Business location address or Bank Address
Allowed values:personalbusinessstatusstringAddress status - invalid, line1_fail, line1_pass, line1_zip_pass, unchecked, verified, zip_fail, zip_pass
Allowed values:invalidline1_passline1_name_passline1_zip_passname_passname_zip_passuncheckedverifiedand 1 morestatestringState
countrystringCountry
Allowed values:BICMzipstringZip
line1stringLine 1
line2stringLine 2
balance_availableinteger<int64>Balance Aavailable for in this account
balance_pendinginteger<int64>Pending balance in this account.
statusstringMerchant Account Status
Allowed values:pendingvalidation_in_progressvalidation_failedvalidated
livebooleanWhether the object exist in live or test mode.
reference_idstringReference Id.
rate_idstringRate Id that can be used on this invoice.
total_amount_paidnumber<double>Total Amount Paid for Partial payments
charge_idsarray of InvoiceChargeIdList of charges Ids linked to the invoice
chargeIdstringaccountTypestringAllowed values:bankbalancecardfeesmobilewalletcaships
quittance_numberstringOBR quittance number generated for this invoice payment.
Status codes
200OK400Bad request401Unauthorized402Payment required403Forbidden404Not found428Precondition required500Server error