Invoices
List all invoices
This endpoint is used for retrievign all invoices.
GET
/api/v1/invoices
Bearer*
{
"invoices": [
{
"applied_taxes": [
{
"fees_amount_cents": "20000",
"lago_invoice_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
"amount_cents": "2000",
"amount_currency": "USD",
"created_at": "2022-09-14T16:35:31Z",
"lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
"lago_tax_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
"tax_code": "french_standard_vat",
"tax_description": "French standard VAT",
"tax_name": "TVA",
"tax_rate": "20"
}
],
"coupons_amount_cents": "10",
"credit_notes_amount_cents": "10",
"currency": "EUR",
"customer": {
"address_line1": "5230 Penfield Ave",
"address_line2": "null",
"applicable_timezone": "America/Los_Angeles",
"billing_configuration": {
"document_locale": "fr",
"invoice_grace_period": "3",
"payment_provider": "stripe",
"provider_customer_id": "cus_12345",
"provider_payment_methods": [
"card",
"sepa_debit"
],
"sync": true,
"sync_with_provider": true
},
"city": "Woodland Hills",
"country": "US",
"created_at": "2022-04-29T08:59:51Z",
"currency": "USD",
"email": "dinesh@piedpiper.test",
"external_id": "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba",
"lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
"legal_name": "Coleman-Blair",
"legal_number": "49-008-2965",
"logo_url": "http://hooli.com/logo.png",
"metadata": [
{
"created_at": "2022-04-29T08:59:51Z",
"display_in_invoice": true,
"key": "Purchase Order",
"lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
"value": "123456789"
}
],
"name": "Gavin Belson",
"net_payment_term": "30",
"phone": "1-171-883-3711 x245",
"sequential_id": "1",
"slug": "LAG-1234-001",
"state": "CA",
"tax_identification_number": "EU123456789",
"timezone": "America/Los_Angeles",
"updated_at": "2022-04-29T08:59:51Z",
"url": "http://hooli.com",
"zipcode": "91364"
},
"fees_amount_cents": "100",
"file_url": "https://getlago.com/invoice/file",
"invoice_type": "subscription",
"issuing_date": "2022-04-30",
"lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
"metadata": [
{
"created_at": "2022-04-29T08:59:51Z",
"key": "digital_ref_id",
"lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
"value": "INV-0123456-98765"
}
],
"net_payment_term": "30",
"number": "LAG-1234-001-002",
"payment_due_date": "2022-04-30",
"payment_status": "succeeded",
"prepaid_credit_amount_cents": "integer",
"sequential_id": "2",
"status": "finalized",
"sub_total_excluding_taxes_amount_cents": "100",
"sub_total_including_taxes_amount_cents": "120",
"taxes_amount_cents": "20",
"total_amount_cents": "100",
"version_number": "3"
}
],
"meta": {
"current_page": "2",
"next_page": "3",
"prev_page": "1",
"total_count": "70",
"total_pages": "4"
}
}
LAGO_URL="https://api.getlago.com"
API_KEY="__YOUR_API_KEY__"
curl --location --request GET "$LAGO_URL/api/v1/invoices?page=2&per_page=20&external_customer_id=hooli_1234" \
--header "Authorization: Bearer $API_KEY"
Authorizations
Authorizationheaderrequired
string
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Query Parameters
page
integer
Page number.
per_page
integer
Number of records per page.
external_customer_id
string
Unique identifier assigned to the customer in your application.
issuing_date_from
string
Filter invoices starting from a specific date.
issuing_date_to
string
Filter invoices up to a specific date.
status
enum<string>
Filter invoices by status. Possible values are draft
or finalized
.
Available options:
draft
, finalized
payment_status
enum<string>
Filter invoices by payment status. Possible values are pending
, failed
or succeeded
.
Available options:
pending
, failed
, succeeded
Response
200 - application/json
invoicesrequired
object[]
metarequired
object
LAGO_URL="https://api.getlago.com"
API_KEY="__YOUR_API_KEY__"
curl --location --request GET "$LAGO_URL/api/v1/invoices?page=2&per_page=20&external_customer_id=hooli_1234" \
--header "Authorization: Bearer $API_KEY"
{
"invoices": [
{
"applied_taxes": [
{
"fees_amount_cents": "20000",
"lago_invoice_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
"amount_cents": "2000",
"amount_currency": "USD",
"created_at": "2022-09-14T16:35:31Z",
"lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
"lago_tax_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
"tax_code": "french_standard_vat",
"tax_description": "French standard VAT",
"tax_name": "TVA",
"tax_rate": "20"
}
],
"coupons_amount_cents": "10",
"credit_notes_amount_cents": "10",
"currency": "EUR",
"customer": {
"address_line1": "5230 Penfield Ave",
"address_line2": "null",
"applicable_timezone": "America/Los_Angeles",
"billing_configuration": {
"document_locale": "fr",
"invoice_grace_period": "3",
"payment_provider": "stripe",
"provider_customer_id": "cus_12345",
"provider_payment_methods": [
"card",
"sepa_debit"
],
"sync": true,
"sync_with_provider": true
},
"city": "Woodland Hills",
"country": "US",
"created_at": "2022-04-29T08:59:51Z",
"currency": "USD",
"email": "dinesh@piedpiper.test",
"external_id": "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba",
"lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
"legal_name": "Coleman-Blair",
"legal_number": "49-008-2965",
"logo_url": "http://hooli.com/logo.png",
"metadata": [
{
"created_at": "2022-04-29T08:59:51Z",
"display_in_invoice": true,
"key": "Purchase Order",
"lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
"value": "123456789"
}
],
"name": "Gavin Belson",
"net_payment_term": "30",
"phone": "1-171-883-3711 x245",
"sequential_id": "1",
"slug": "LAG-1234-001",
"state": "CA",
"tax_identification_number": "EU123456789",
"timezone": "America/Los_Angeles",
"updated_at": "2022-04-29T08:59:51Z",
"url": "http://hooli.com",
"zipcode": "91364"
},
"fees_amount_cents": "100",
"file_url": "https://getlago.com/invoice/file",
"invoice_type": "subscription",
"issuing_date": "2022-04-30",
"lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
"metadata": [
{
"created_at": "2022-04-29T08:59:51Z",
"key": "digital_ref_id",
"lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
"value": "INV-0123456-98765"
}
],
"net_payment_term": "30",
"number": "LAG-1234-001-002",
"payment_due_date": "2022-04-30",
"payment_status": "succeeded",
"prepaid_credit_amount_cents": "integer",
"sequential_id": "2",
"status": "finalized",
"sub_total_excluding_taxes_amount_cents": "100",
"sub_total_including_taxes_amount_cents": "120",
"taxes_amount_cents": "20",
"total_amount_cents": "100",
"version_number": "3"
}
],
"meta": {
"current_page": "2",
"next_page": "3",
"prev_page": "1",
"total_count": "70",
"total_pages": "4"
}
}