List Invoices

You have successfully created invoice(s). Once invoices are submitted via the Batch Create Invoices API endpoint, they are queued for payment immediately. You can watch your payments flow through the payment lifecycle using the List Payments endpoint or the Get Payment Detail endpoint.

Before you can view the payment(s), you will first need to retrieve the invoice(s) to get the payment ID. The payment {id} is provided in the invoice response.

You can get a List Invoices or if you have the invoice key ("id" returned in the response when you created the invoice) you can use the Get Invoice Detail endpoint.

Get a list of invoices

You can use this endpoint to get a full list of your invoices. This list can also be narrowed down to a specific page with Pagination.

A sample response looks as follows:

{
    "count": 2,
    "next": "http://localhost:8000/v2/invoices/?page=2",
    "previous": null,
    "results": [
        {
        "id": "inv_ucqrciuy357w7oha23k0",
        "amount_cents": 10000,
        "currency": "USD",
        "discount_amount_cents": 0,
        "invoice_date": "2023-03-24",
        "invoice_due_date": "2023-03-25",
        "invoice_number": "12345",
        "note": "April's Annual Tire Order",
        "originating_counterparty_id": "0b575520-d4fc-47a5-a27a-7b2c062e075f",
        "receiving_counterparty_id": "b1d5a7e8-62fa-4e38-93bf-6be23bdefa82",
        "metadata": {},
        "payment_id": "pmt_vcjrmg7xcspkiv7n54bq",
        "reconciliation_id": "Check No. 1145",
        "created": "2023-03-24T21:08:42.974067",
        "updated": "2023-03-24T21:08:42.974073",
        "account_number": "68484854"
        },
        {
    		"id": "inv_ghytuenxw5jwco3aary8",
    		"amount_cents": 20000,
    		"currency": "USD",
     		"discount_amount_cents": 0,
      	"invoice_date": "2023-03-24",
        "invoice_due_date": "2023-03-25",
        "invoice_number": "12346",
        "note": "April's Annual Brake Order",
        "originating_counterparty_id": "0b575520-d4fc-47a5-a27a-7b2c062e075f",
        "receiving_counterparty_id": "b1d5a7e8-62fa-4e38-93bf-6be23bdefa82",
        "metadata": {},
        "payment_id": "pmt_nmjrmg0xcspkiv67n23th",
        "reconciliation_id": "Check No. 1145",
        "created": "2023-03-24T21:08:43.017807",
        "updated": "2023-03-24T21:08:43.017814",
        "account_number": "68484854"
        },
      ]
}

Search for a single invoice

To get details for a single invoice, enter the "id" you received in the response after you created the invoice in (http://stage.api.finexio.com/v2/invoices/{key}/).

A sample result looks as follows:

{
        "id": "inv_ghytuenxw5jwco3aary8",
    		"amount_cents": 20000,
    		"currency": "USD",
     		"discount_amount_cents": 0,
      	"invoice_date": "2023-03-24",
        "invoice_due_date": "2023-03-25",
        "invoice_number": "12346",
        "note": "April's Annual Brake Order",
        "originating_counterparty_id": "0b575520-d4fc-47a5-a27a-7b2c062e075f",
        "receiving_counterparty_id": "b1d5a7e8-62fa-4e38-93bf-6be23bdefa82",
        "metadata": {},
        "payment_id": "pmt_nmjrmg0xcspkiv67n23th",
        "reconciliation_id": "Check No. 1145",
        "created": "2023-03-24T21:08:43.017807",
        "updated": "2023-03-24T21:08:43.017814",
        "account_number": "68484854"
}