- Documentation
- API References
- Integrations
- Templates
- Blog
- FAQ
- GitHub
- Getting started
Add-ons
Analytics
Billable metrics
Coupons
Credit notes
Customer usage
Customers
Events
Fees
Invoices
Organizations
Plans
Resources
Subscriptions
Taxes
Wallets
Webhook endpoints
Webhooks
API Reference
List all invoices
This endpoint is used for retrievign all invoices.
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Page number.
Number of records per page.
Unique identifier assigned to the customer in your application.
Filter invoices starting from a specific date.
Filter invoices up to a specific date.
Filter invoices by status. Possible values are draft
or finalized
.
Filter invoices by payment status. Possible values are pending
, failed
or succeeded
.
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": [
{
"lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
"sequential_id": 2,
"number": "LAG-1234-001-002",
"issuing_date": "2022-04-30",
"payment_dispute_lost_at": "2022-09-14T16:35:31Z",
"payment_due_date": "2022-04-30",
"net_payment_term": 30,
"invoice_type": "subscription",
"status": "finalized",
"payment_status": "succeeded",
"currency": "EUR",
"fees_amount_cents": 100,
"coupons_amount_cents": 10,
"credit_notes_amount_cents": 10,
"sub_total_excluding_taxes_amount_cents": 100,
"taxes_amount_cents": 20,
"sub_total_including_taxes_amount_cents": 120,
"prepaid_credit_amount_cents": 123,
"total_amount_cents": 100,
"version_number": 3,
"file_url": "https://getlago.com/invoice/file",
"customer": {
"lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
"sequential_id": 1,
"slug": "LAG-1234-001",
"external_id": "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba",
"address_line1": "5230 Penfield Ave",
"address_line2": "<string>",
"applicable_timezone": "America/Los_Angeles",
"city": "Woodland Hills",
"country": "US",
"currency": "USD",
"email": "dinesh@piedpiper.test",
"legal_name": "Coleman-Blair",
"legal_number": "49-008-2965",
"logo_url": "http://hooli.com/logo.png",
"name": "Gavin Belson",
"phone": "1-171-883-3711 x245",
"state": "CA",
"tax_identification_number": "EU123456789",
"timezone": "America/Los_Angeles",
"url": "http://hooli.com",
"zipcode": "91364",
"net_payment_term": 30,
"created_at": "2022-04-29T08:59:51Z",
"updated_at": "2022-04-29T08:59:51Z",
"billing_configuration": {
"invoice_grace_period": 3,
"payment_provider": "stripe",
"payment_provider_code": "stripe-eu-1",
"provider_customer_id": "cus_12345",
"sync": true,
"sync_with_provider": true,
"document_locale": "fr",
"provider_payment_methods": [
"card",
"sepa_debit"
]
},
"metadata": [
{
"lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
"key": "Purchase Order",
"value": "123456789",
"display_in_invoice": true,
"created_at": "2022-04-29T08:59:51Z"
}
]
},
"metadata": [
{
"lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
"key": "digital_ref_id",
"value": "INV-0123456-98765",
"created_at": "2022-04-29T08:59:51Z"
}
],
"applied_taxes": [
{
"lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
"lago_tax_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
"tax_name": "TVA",
"tax_code": "french_standard_vat",
"tax_rate": 20,
"tax_description": "French standard VAT",
"amount_cents": 2000,
"amount_currency": "USD",
"created_at": "2022-09-14T16:35:31Z",
"lago_invoice_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
"fees_amount_cents": 20000
}
]
}
],
"meta": {
"current_page": 2,
"next_page": 3,
"prev_page": 1,
"total_pages": 4,
"total_count": 70
}
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Query Parameters
Page number.
Number of records per page.
Unique identifier assigned to the customer in your application.
Filter invoices starting from a specific date.
Filter invoices up to a specific date.
Filter invoices by status. Possible values are draft
or finalized
.
draft
, finalized
Filter invoices by payment status. Possible values are pending
, failed
or succeeded
.
pending
, failed
, succeeded
Response
Unique identifier assigned to the fee within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the fee’s record within the Lago system.
This ID helps in uniquely identifying and organizing the invoices associated with a specific customer. It provides a sequential numbering system specific to the customer, allowing for easy tracking and management of invoices within the customer's context.
The unique number assigned to the invoice. This number serves as a distinct identifier for the invoice and helps in differentiating it from other invoices in the system.
The date when the invoice was issued. It is provided in the ISO 8601 date format.
The date when the payment dispute was lost. It is expressed in Coordinated Universal Time (UTC).
The payment due date for the invoice, specified in the ISO 8601 date format.
The net payment term, expressed in days, specifies the duration within which a customer is expected to remit payment after the invoice is finalized.
The type of invoice issued. Possible values are subscription
, one-off
or credit
.
subscription
, add_on
, credit
, one_off
The status of the invoice. It indicates the current state of the invoice and can have two possible values:
draft
: the invoice is in the draft state, waiting for the end of the grace period to be finalized. During this period, events can still be ingested and added to the invoice.finalized
: the invoice has been issued and finalized. In this state, events cannot be ingested or added to the invoice anymore.voided
: the invoice has been issued and subsequently voided. In this state, events cannot be ingested or added to the invoice anymore.
draft
, finalized
, voided
The status of the payment associated with the invoice. It can have one of the following values:
pending
: the payment is pending, waiting for payment processing in Stripe or when the invoice is emitted but users have not updated the payment status through the endpoint.succeeded
: the payment of the invoice has been successfully processed.failed
: the payment of the invoice has failed or encountered an error during processing.
pending
, succeeded
, failed
The currency of the invoice issued.
AED
, AFN
, ALL
, AMD
, ANG
, AOA
, ARS
, AUD
, AWG
, AZN
, BAM
, BBD
, BDT
, BGN
, BIF
, BMD
, BND
, BOB
, BRL
, BSD
, BWP
, BYN
, BZD
, CAD
, CDF
, CHF
, CLF
, CLP
, CNY
, COP
, CRC
, CVE
, CZK
, DJF
, DKK
, DOP
, DZD
, EGP
, ETB
, EUR
, FJD
, FKP
, GBP
, GEL
, GIP
, GMD
, GNF
, GTQ
, GYD
, HKD
, HNL
, HRK
, HTG
, HUF
, IDR
, ILS
, INR
, ISK
, JMD
, JPY
, KES
, KGS
, KHR
, KMF
, KRW
, KYD
, KZT
, LAK
, LBP
, LKR
, LRD
, LSL
, MAD
, MDL
, MGA
, MKD
, MMK
, MNT
, MOP
, MRO
, MUR
, MVR
, MWK
, MXN
, MYR
, MZN
, NAD
, NGN
, NIO
, NOK
, NPR
, NZD
, PAB
, PEN
, PGK
, PHP
, PKR
, PLN
, PYG
, QAR
, RON
, RSD
, RUB
, RWF
, SAR
, SBD
, SCR
, SEK
, SGD
, SHP
, SLL
, SOS
, SRD
, STD
, SZL
, THB
, TJS
, TOP
, TRY
, TTD
, TWD
, TZS
, UAH
, UGX
, USD
, UYU
, UZS
, VND
, VUV
, WST
, XAF
, XCD
, XOF
, XPF
, YER
, ZAR
, ZMW
The total sum of fees amount in cents. It calculates the cumulative amount of all the fees associated with the invoice, providing a consolidated value.
The total sum of all coupons discounted on the invoice. It calculates the cumulative discount amount applied by coupons, expressed in cents.
The total sum of all credit notes discounted on the invoice. It calculates the cumulative discount amount applied by credit notes, expressed in cents.
Subtotal amount, excluding taxes, expressed in cents. This field depends on the version number. Here are the definitions based on the version:
- Version 1: is equal to the sum of
fees_amount_cents
, minuscoupons_amount_cents
, and minusprepaid_credit_amount_cents
. - Version 2: is equal to the
fees_amount_cents
. - Version 3: is equal to the
fees_amount_cents
, minuscoupons_amount_cents
The sum of tax amount associated with the invoice, expressed in cents.
Subtotal amount, including taxes, expressed in cents. This field depends on the version number. Here are the definitions based on the version:
- Version 1: is equal to the
total_amount_cents
. - Version 2: is equal to the sum of
fees_amount_cents
andtaxes_amount_cents
. - Version 3: is equal to the sum
sub_total_excluding_taxes_amount_cents
andtaxes_amount_cents
The total sum of all prepaid credits discounted on the invoice. It calculates the cumulative discount amount applied by prepaid credits, expressed in cents.
The sum of the amount and taxes amount on the invoice, expressed in cents. It calculates the total financial value of the invoice, including both the original amount and any applicable taxes.
Contains the URL that provides direct access to the invoice PDF file. You can use this URL to download or view the PDF document of the invoice
The customer on which the invoice applies. It refers to the customer account or entity associated with the invoice.
Unique identifier assigned to the customer within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the customer's record within the Lago system
The unique identifier assigned to the customer within the organization's scope. This identifier is used to track and reference the customer's order of creation within the organization's system. It ensures that each customer has a distinct `sequential_id`` associated with them, allowing for easy identification and sorting based on the order of creation
A concise and unique identifier for the customer, formed by combining the Organization's name
, id
, and customer's sequential_id
The customer external unique identifier (provided by your own application)
The first line of the billing address
The second line of the billing address
The customer's applicable timezone, used for billing purposes in their local time.
UTC
, Africa/Algiers
, Africa/Cairo
, Africa/Casablanca
, Africa/Harare
, Africa/Johannesburg
, Africa/Monrovia
, Africa/Nairobi
, America/Argentina/Buenos_Aires
, America/Bogota
, America/Caracas
, America/Chicago
, America/Chihuahua
, America/Denver
, America/Godthab
, America/Guatemala
, America/Guyana
, America/Halifax
, America/Indiana/Indianapolis
, America/Juneau
, America/La_Paz
, America/Lima
, America/Los_Angeles
, America/Mazatlan
, America/Mexico_City
, America/Monterrey
, America/Montevideo
, America/New_York
, America/Phoenix
, America/Puerto_Rico
, America/Regina
, America/Santiago
, America/Sao_Paulo
, America/St_Johns
, America/Tijuana
, Asia/Almaty
, Asia/Baghdad
, Asia/Baku
, Asia/Bangkok
, Asia/Chongqing
, Asia/Colombo
, Asia/Dhaka
, Asia/Hong_Kong
, Asia/Irkutsk
, Asia/Jakarta
, Asia/Jerusalem
, Asia/Kabul
, Asia/Kamchatka
, Asia/Karachi
, Asia/Kathmandu
, Asia/Kolkata
, Asia/Krasnoyarsk
, Asia/Kuala_Lumpur
, Asia/Kuwait
, Asia/Magadan
, Asia/Muscat
, Asia/Novosibirsk
, Asia/Rangoon
, Asia/Riyadh
, Asia/Seoul
, Asia/Shanghai
, Asia/Singapore
, Asia/Srednekolymsk
, Asia/Taipei
, Asia/Tashkent
, Asia/Tbilisi
, Asia/Tehran
, Asia/Tokyo
, Asia/Ulaanbaatar
, Asia/Urumqi
, Asia/Vladivostok
, Asia/Yakutsk
, Asia/Yekaterinburg
, Asia/Yerevan
, Atlantic/Azores
, Atlantic/Cape_Verde
, Atlantic/South_Georgia
, Australia/Adelaide
, Australia/Brisbane
, Australia/Darwin
, Australia/Hobart
, Australia/Melbourne
, Australia/Perth
, Australia/Sydney
, Europe/Amsterdam
, Europe/Athens
, Europe/Belgrade
, Europe/Berlin
, Europe/Bratislava
, Europe/Brussels
, Europe/Bucharest
, Europe/Budapest
, Europe/Copenhagen
, Europe/Dublin
, Europe/Helsinki
, Europe/Istanbul
, Europe/Kaliningrad
, Europe/Kiev
, Europe/Lisbon
, Europe/Ljubljana
, Europe/London
, Europe/Madrid
, Europe/Minsk
, Europe/Moscow
, Europe/Paris
, Europe/Prague
, Europe/Riga
, Europe/Rome
, Europe/Samara
, Europe/Sarajevo
, Europe/Skopje
, Europe/Sofia
, Europe/Stockholm
, Europe/Tallinn
, Europe/Vienna
, Europe/Vilnius
, Europe/Volgograd
, Europe/Warsaw
, Europe/Zagreb
, Europe/Zurich
, GMT+12
, Pacific/Apia
, Pacific/Auckland
, Pacific/Chatham
, Pacific/Fakaofo
, Pacific/Fiji
, Pacific/Guadalcanal
, Pacific/Guam
, Pacific/Honolulu
, Pacific/Majuro
, Pacific/Midway
, Pacific/Noumea
, Pacific/Pago_Pago
, Pacific/Port_Moresby
, Pacific/Tongatapu
The city of the customer's billing address
Country code of the customer's billing address. Format must be ISO 3166 (alpha-2)
AD
, AE
, AF
, AG
, AI
, AL
, AM
, AO
, AQ
, AR
, AS
, AT
, AU
, AW
, AX
, AZ
, BA
, BB
, BD
, BE
, BF
, BG
, BH
, BI
, BJ
, BL
, BM
, BN
, BO
, BQ
, BR
, BS
, BT
, BV
, BW
, BY
, BZ
, CA
, CC
, CD
, CF
, CG
, CH
, CI
, CK
, CL
, CM
, CN
, CO
, CR
, CU
, CV
, CW
, CX
, CY
, CZ
, DE
, DJ
, DK
, DM
, DO
, DZ
, EC
, EE
, EG
, EH
, ER
, ES
, ET
, FI
, FJ
, FK
, FM
, FO
, FR
, GA
, GB
, GD
, GE
, GF
, GG
, GH
, GI
, GL
, GM
, GN
, GP
, GQ
, GR
, GS
, GT
, GU
, GW
, GY
, HK
, HM
, HN
, HR
, HT
, HU
, ID
, IE
, IL
, IM
, IN
, IO
, IQ
, IR
, IS
, IT
, JE
, JM
, JO
, JP
, KE
, KG
, KH
, KI
, KM
, KN
, KP
, KR
, KW
, KY
, KZ
, LA
, LB
, LC
, LI
, LK
, LR
, LS
, LT
, LU
, LV
, LY
, MA
, MC
, MD
, ME
, MF
, MG
, MH
, MK
, ML
, MM
, MN
, MO
, MP
, MQ
, MR
, MS
, MT
, MU
, MV
, MW
, MX
, MY
, MZ
, NA
, NC
, NE
, NF
, NG
, NI
, NL
, NO
, NP
, NR
, NU
, NZ
, OM
, PA
, PE
, PF
, PG
, PH
, PK
, PL
, PM
, PN
, PR
, PS
, PT
, PW
, PY
, QA
, RE
, RO
, RS
, RU
, RW
, SA
, SB
, SC
, SD
, SE
, SG
, SH
, SI
, SJ
, SK
, SL
, SM
, SN
, SO
, SR
, SS
, ST
, SV
, SX
, SY
, SZ
, TC
, TD
, TF
, TG
, TH
, TJ
, TK
, TL
, TM
, TN
, TO
, TR
, TT
, TV
, TW
, TZ
, UA
, UG
, UM
, US
, UY
, UZ
, VA
, VC
, VE
, VG
, VI
, VN
, VU
, WF
, WS
, YE
, YT
, ZA
, ZM
, ZW
Currency of the customer. Format must be ISO 4217
AED
, AFN
, ALL
, AMD
, ANG
, AOA
, ARS
, AUD
, AWG
, AZN
, BAM
, BBD
, BDT
, BGN
, BIF
, BMD
, BND
, BOB
, BRL
, BSD
, BWP
, BYN
, BZD
, CAD
, CDF
, CHF
, CLF
, CLP
, CNY
, COP
, CRC
, CVE
, CZK
, DJF
, DKK
, DOP
, DZD
, EGP
, ETB
, EUR
, FJD
, FKP
, GBP
, GEL
, GIP
, GMD
, GNF
, GTQ
, GYD
, HKD
, HNL
, HRK
, HTG
, HUF
, IDR
, ILS
, INR
, ISK
, JMD
, JPY
, KES
, KGS
, KHR
, KMF
, KRW
, KYD
, KZT
, LAK
, LBP
, LKR
, LRD
, LSL
, MAD
, MDL
, MGA
, MKD
, MMK
, MNT
, MOP
, MRO
, MUR
, MVR
, MWK
, MXN
, MYR
, MZN
, NAD
, NGN
, NIO
, NOK
, NPR
, NZD
, PAB
, PEN
, PGK
, PHP
, PKR
, PLN
, PYG
, QAR
, RON
, RSD
, RUB
, RWF
, SAR
, SBD
, SCR
, SEK
, SGD
, SHP
, SLL
, SOS
, SRD
, STD
, SZL
, THB
, TJS
, TOP
, TRY
, TTD
, TWD
, TZS
, UAH
, UGX
, USD
, UYU
, UZS
, VND
, VUV
, WST
, XAF
, XCD
, XOF
, XPF
, YER
, ZAR
, ZMW
The email of the customer
The legal company name of the customer
The legal company number of the customer
The logo URL of the customer
The full name of the customer
The phone number of the customer
The state of the customer's billing address
The tax identification number of the customer
The customer's timezone, used for billing purposes in their local time. Overrides the organization's timezone
UTC
, Africa/Algiers
, Africa/Cairo
, Africa/Casablanca
, Africa/Harare
, Africa/Johannesburg
, Africa/Monrovia
, Africa/Nairobi
, America/Argentina/Buenos_Aires
, America/Bogota
, America/Caracas
, America/Chicago
, America/Chihuahua
, America/Denver
, America/Godthab
, America/Guatemala
, America/Guyana
, America/Halifax
, America/Indiana/Indianapolis
, America/Juneau
, America/La_Paz
, America/Lima
, America/Los_Angeles
, America/Mazatlan
, America/Mexico_City
, America/Monterrey
, America/Montevideo
, America/New_York
, America/Phoenix
, America/Puerto_Rico
, America/Regina
, America/Santiago
, America/Sao_Paulo
, America/St_Johns
, America/Tijuana
, Asia/Almaty
, Asia/Baghdad
, Asia/Baku
, Asia/Bangkok
, Asia/Chongqing
, Asia/Colombo
, Asia/Dhaka
, Asia/Hong_Kong
, Asia/Irkutsk
, Asia/Jakarta
, Asia/Jerusalem
, Asia/Kabul
, Asia/Kamchatka
, Asia/Karachi
, Asia/Kathmandu
, Asia/Kolkata
, Asia/Krasnoyarsk
, Asia/Kuala_Lumpur
, Asia/Kuwait
, Asia/Magadan
, Asia/Muscat
, Asia/Novosibirsk
, Asia/Rangoon
, Asia/Riyadh
, Asia/Seoul
, Asia/Shanghai
, Asia/Singapore
, Asia/Srednekolymsk
, Asia/Taipei
, Asia/Tashkent
, Asia/Tbilisi
, Asia/Tehran
, Asia/Tokyo
, Asia/Ulaanbaatar
, Asia/Urumqi
, Asia/Vladivostok
, Asia/Yakutsk
, Asia/Yekaterinburg
, Asia/Yerevan
, Atlantic/Azores
, Atlantic/Cape_Verde
, Atlantic/South_Georgia
, Australia/Adelaide
, Australia/Brisbane
, Australia/Darwin
, Australia/Hobart
, Australia/Melbourne
, Australia/Perth
, Australia/Sydney
, Europe/Amsterdam
, Europe/Athens
, Europe/Belgrade
, Europe/Berlin
, Europe/Bratislava
, Europe/Brussels
, Europe/Bucharest
, Europe/Budapest
, Europe/Copenhagen
, Europe/Dublin
, Europe/Helsinki
, Europe/Istanbul
, Europe/Kaliningrad
, Europe/Kiev
, Europe/Lisbon
, Europe/Ljubljana
, Europe/London
, Europe/Madrid
, Europe/Minsk
, Europe/Moscow
, Europe/Paris
, Europe/Prague
, Europe/Riga
, Europe/Rome
, Europe/Samara
, Europe/Sarajevo
, Europe/Skopje
, Europe/Sofia
, Europe/Stockholm
, Europe/Tallinn
, Europe/Vienna
, Europe/Vilnius
, Europe/Volgograd
, Europe/Warsaw
, Europe/Zagreb
, Europe/Zurich
, GMT+12
, Pacific/Apia
, Pacific/Auckland
, Pacific/Chatham
, Pacific/Fakaofo
, Pacific/Fiji
, Pacific/Guadalcanal
, Pacific/Guam
, Pacific/Honolulu
, Pacific/Majuro
, Pacific/Midway
, Pacific/Noumea
, Pacific/Pago_Pago
, Pacific/Port_Moresby
, Pacific/Tongatapu
The custom website URL of the customer
The zipcode of the customer's billing address
The net payment term, expressed in days, specifies the duration within which a customer is expected to remit payment after the invoice is finalized.
The date of the customer creation, represented in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC). The creation_date provides a standardized and internationally recognized timestamp for when the customer object was created
The date of the customer update, represented in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC). The update_date provides a standardized and internationally recognized timestamp for when the customer object was updated
Configuration specific to the payment provider, utilized for billing the customer. This object contains settings and parameters necessary for processing payments and invoicing the customer.
The grace period, expressed in days, for the invoice. This period refers to the additional time granted to the customer beyond the invoice due date to adjust usage and line items
The payment provider utilized to initiate payments for invoices issued by Lago.
Accepted values: stripe
, adyen
, gocardless
or null. This field is required if you intend to assign a provider_customer_id
.
stripe
, adyen
, gocardless
Unique code used to identify a payment provider connection.
The customer ID within the payment provider's system. If this field is not provided, Lago has the option to create a new customer record within the payment provider's system on behalf of the customer
Set this field to true
if you want to create the customer in the payment provider synchronously with the customer creation process in Lago. This option is applicable only when the provider_customer_id
is null
and the customer is automatically created in the payment provider through Lago. By default, the value is set to false
Set this field to true
if you want to create a customer record in the payment provider's system. This option is applicable only when the provider_customer_id
is null and the sync_with_provider
field is set to true
. By default, the value is set to false
The document locale, specified in the ISO 639-1 format. This field represents the language or locale used for the documents issued by Lago
Specifies the available payment methods that can be used for this customer when payment_provider
is set to stripe
. The provider_payment_methods
field is an array that allows multiple payment options to be defined. If this field is not explicitly set, all the payment methods are selected. For now, possible values are card
and sepa_debit
.
A unique identifier for the customer metadata object in the Lago application. Can be used to update a key-value pair
The metadata object key
The metadata object value
Determines whether the item or information should be displayed in the invoice. If set to true, the item or information will be included and visible in the generated invoice. If set to false, the item or information will be excluded and not displayed in the invoice.
The date of the metadata object creation, represented in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC). The creation_date provides a standardized and internationally recognized timestamp for when the metadata object was created
Unique identifier assigned to the invoice metadata within the Lago application.
Represents the key of the metadata’s key-value pair.
Represents the value of the metadata’s key-value pair.
The date and time when the metadata object was created. It follows the ISO 8601 datetime format and is expressed in Coordinated Universal Time (UTC).
Unique identifier of the applied tax, created by Lago.
Unique identifier of the tax, created by Lago.
Name of the tax.
Unique code used to identify the tax associated with the API request.
The percentage rate of the tax
Internal description of the taxe
Amount of the tax
Currency of the tax
AED
, AFN
, ALL
, AMD
, ANG
, AOA
, ARS
, AUD
, AWG
, AZN
, BAM
, BBD
, BDT
, BGN
, BIF
, BMD
, BND
, BOB
, BRL
, BSD
, BWP
, BYN
, BZD
, CAD
, CDF
, CHF
, CLF
, CLP
, CNY
, COP
, CRC
, CVE
, CZK
, DJF
, DKK
, DOP
, DZD
, EGP
, ETB
, EUR
, FJD
, FKP
, GBP
, GEL
, GIP
, GMD
, GNF
, GTQ
, GYD
, HKD
, HNL
, HRK
, HTG
, HUF
, IDR
, ILS
, INR
, ISK
, JMD
, JPY
, KES
, KGS
, KHR
, KMF
, KRW
, KYD
, KZT
, LAK
, LBP
, LKR
, LRD
, LSL
, MAD
, MDL
, MGA
, MKD
, MMK
, MNT
, MOP
, MRO
, MUR
, MVR
, MWK
, MXN
, MYR
, MZN
, NAD
, NGN
, NIO
, NOK
, NPR
, NZD
, PAB
, PEN
, PGK
, PHP
, PKR
, PLN
, PYG
, QAR
, RON
, RSD
, RUB
, RWF
, SAR
, SBD
, SCR
, SEK
, SGD
, SHP
, SLL
, SOS
, SRD
, STD
, SZL
, THB
, TJS
, TOP
, TRY
, TTD
, TWD
, TZS
, UAH
, UGX
, USD
, UYU
, UZS
, VND
, VUV
, WST
, XAF
, XCD
, XOF
, XPF
, YER
, ZAR
, ZMW
The date and time when the applied tax was created. It is expressed in UTC format according to the ISO 8601 datetime standard. This field provides the timestamp for the exact moment when the applied tax was initially created.
Unique identifier of the invoice, created by Lago.
Fees total amount on which the tax is applied
Current page.
Next page.
Previous page.
Total number of pages.
Total number of records.
Was this page helpful?
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": [
{
"lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
"sequential_id": 2,
"number": "LAG-1234-001-002",
"issuing_date": "2022-04-30",
"payment_dispute_lost_at": "2022-09-14T16:35:31Z",
"payment_due_date": "2022-04-30",
"net_payment_term": 30,
"invoice_type": "subscription",
"status": "finalized",
"payment_status": "succeeded",
"currency": "EUR",
"fees_amount_cents": 100,
"coupons_amount_cents": 10,
"credit_notes_amount_cents": 10,
"sub_total_excluding_taxes_amount_cents": 100,
"taxes_amount_cents": 20,
"sub_total_including_taxes_amount_cents": 120,
"prepaid_credit_amount_cents": 123,
"total_amount_cents": 100,
"version_number": 3,
"file_url": "https://getlago.com/invoice/file",
"customer": {
"lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
"sequential_id": 1,
"slug": "LAG-1234-001",
"external_id": "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba",
"address_line1": "5230 Penfield Ave",
"address_line2": "<string>",
"applicable_timezone": "America/Los_Angeles",
"city": "Woodland Hills",
"country": "US",
"currency": "USD",
"email": "dinesh@piedpiper.test",
"legal_name": "Coleman-Blair",
"legal_number": "49-008-2965",
"logo_url": "http://hooli.com/logo.png",
"name": "Gavin Belson",
"phone": "1-171-883-3711 x245",
"state": "CA",
"tax_identification_number": "EU123456789",
"timezone": "America/Los_Angeles",
"url": "http://hooli.com",
"zipcode": "91364",
"net_payment_term": 30,
"created_at": "2022-04-29T08:59:51Z",
"updated_at": "2022-04-29T08:59:51Z",
"billing_configuration": {
"invoice_grace_period": 3,
"payment_provider": "stripe",
"payment_provider_code": "stripe-eu-1",
"provider_customer_id": "cus_12345",
"sync": true,
"sync_with_provider": true,
"document_locale": "fr",
"provider_payment_methods": [
"card",
"sepa_debit"
]
},
"metadata": [
{
"lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
"key": "Purchase Order",
"value": "123456789",
"display_in_invoice": true,
"created_at": "2022-04-29T08:59:51Z"
}
]
},
"metadata": [
{
"lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
"key": "digital_ref_id",
"value": "INV-0123456-98765",
"created_at": "2022-04-29T08:59:51Z"
}
],
"applied_taxes": [
{
"lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
"lago_tax_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
"tax_name": "TVA",
"tax_code": "french_standard_vat",
"tax_rate": 20,
"tax_description": "French standard VAT",
"amount_cents": 2000,
"amount_currency": "USD",
"created_at": "2022-09-14T16:35:31Z",
"lago_invoice_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
"fees_amount_cents": 20000
}
]
}
],
"meta": {
"current_page": 2,
"next_page": 3,
"prev_page": 1,
"total_pages": 4,
"total_count": 70
}
}