v1

latestOpenAPI 3.0.32026-07-248257161.1 KB

Invoices

Returns list of invoices

This API returns the list of invoices for a merchant.

get/invoices

Query parameters

start_datestring date

Example:2023-05-22

Query invoices starting from this date. The date format is (YYYY-mm-dd). If omitted, 2023-09-01 is used

end_datestring date

Example:2023-05-24

Query invoices from start_date until this date time. The date format is YYYY-mm-dd. If end_date is omitted, current date is used.

status'opened' | 'paid' | 'paid_in_cash'

Filter by invoice status. The status filter is combined with start_date and end_date filters. When filtering by opened status, invoices with due date in the past are shown expired

device_idstring

Filter by payment link by device_id. The status filter is combined with start_date and end_date filters.Cannot be used with status filter

page_offsetinteger

pagination offset, default is 0.

page_sizeinteger

Page size. default value is 20

Response

returns list of invoices.

idstring

unique uuid of the invoice

referencestring

invoice reference

customerIdstring

unique identifier of the customer, recipient of the invoice

customerNamestring

Customer Full name, recipient of the payment link

currencystring required

invoice currency

dueDatestring date required

invoice due date

subTotalAmountnumber double

total price of items bought by the customer without tax

deliveryChargesnumber double

shipping costs

deductedAmountnumber double

amount in absolute value to be deducted to final amount

totalTaxnumber double

total tax collected

finalAmountnumber double

final amount to be paid by the customer including tax

status'opened' | 'paid' | 'paid_in_cash' | 'expired'

Invoice status

redirectUrlAfterPaymentstring

Optional. Provide an url if you want to redirect customer after successful payment is done.

deviceIdstring

The identifier of the device used to make the request

enableMultiplePaymentboolean

By default, only one payment is authorized on each invoice. In case you want to allow multiple payment (recurrent payment) on this invoice, set the value to true

nbrPaymentsinteger

If enableMultiplePayment is set true, the syteme will count the number of success payments performed on this invoice. This field is ignored if enableMultiplePayment is set to false

paymentUrlstring

invoice payment url. This url link is sent to the customer to allow him to pay the invoice.

downloadUrlstring

invoice payment url. This url link is sent to the customer to allow him to download the invoice.

createdAtstring

The date time that record was created in our system.

updatedAtstring

The date time that record was updated in our system.

Example response

[
  {
    "id": "638d4133957e3caf63e6b79c",
    "reference": "3245GOF456",
    "customerId": "d2d2053b-638d-4133-957e-3caf63e6b79c",
    "customerName": "John Smith",
    "currency": "XOF",
    "dueDate": "2024-04-24",
    "orderDetails": [
      {
        "id": "fbd2053b-638d-4133-957e-3caf63e6b79c",
        "name": "pineapple",
        "reference": "SKU56789002",
        "price": 100,
        "quantity": 2.5,
        "discount": 20,
        "taxRate": 5.5,
        "totalPrice": 125
      }
    ],
    "subTotalAmount": 5000,
    "deliveryCharges": 90,
    "deductedAmount": 50,
    "totalTax": 500,
    "finalAmount": 5550,
    "status": "paid",
    "redirectUrlAfterPayment": "https://merchant-online-store",
    "deviceId": "SN-4562345",
    "enableMultiplePayment": true,
    "nbrPayments": 5,
    "paymentUrl": "https://web.bictorys.com/invoice-management/pay/638d4133957e3caf63e6b79c?op_token=ert4133957e3caf63e6b79c",
    "downloadUrl": "https://web.bictorys.com/invoice-management/download/638d4133957e3caf63e6b79c?op_token=abc4133957e3caf63e6b79c",
    "createdAt": "2022-06-20T17:17:11Z",
    "updatedAt": "2022-06-20T17:17:11Z"
  }
]