Skip to content
This repository has been archived by the owner on Dec 12, 2024. It is now read-only.

Latest commit

 

History

History
262 lines (146 loc) · 7.16 KB

InvoicesApi.md

File metadata and controls

262 lines (146 loc) · 7.16 KB
Raw

\InvoicesApi

All URIs are relative to https://api.getlago.com/api/v1

Method HTTP request Description
create_invoice POST /invoices Create a new invoice
download_invoice POST /invoices/{id}/download Download an existing invoice
finalize_invoice PUT /invoices/{id}/finalize Finalize a draft invoice
find_all_invoices GET /invoices Find all invoices
find_invoice GET /invoices/{id} Find invoice by ID
refresh_invoice PUT /invoices/{id}/refresh Refresh a draft invoice
retry_payment POST /invoices/{id}/retry_payment Retry invoice payment
update_invoice PUT /invoices/{id} Update an existing invoice status

create_invoice

crate::models::Invoice create_invoice(invoice_one_off_input) Create a new invoice

Create a new one off Invoice

Parameters

Name Type Description Required Notes
invoice_one_off_input InvoiceOneOffInput Invoice payload [required]

Return type

crate::models::Invoice

Authorization

bearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

download_invoice

crate::models::Invoice download_invoice(id) Download an existing invoice

Download an existing invoice

Parameters

Name Type Description Required Notes
id uuid::Uuid ID of the existing Lago Invoice [required]

Return type

crate::models::Invoice

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

finalize_invoice

crate::models::Invoice finalize_invoice(id) Finalize a draft invoice

Finalize a draft invoice

Parameters

Name Type Description Required Notes
id uuid::Uuid ID of the draft Lago Invoice [required]

Return type

crate::models::Invoice

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

find_all_invoices

crate::models::InvoicesPaginated find_all_invoices(page, per_page, external_customer_id, issuing_date_from, issuing_date_to, status) Find all invoices

Find all invoices in certain organisation

Parameters

Name Type Description Required Notes
page Option<i32> Number of page
per_page Option<i32> Number of records per page
external_customer_id Option<String> External customer ID
issuing_date_from Option<String> Date from
issuing_date_to Option<String> Date to
status Option<String> Status

Return type

crate::models::InvoicesPaginated

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

find_invoice

crate::models::Invoice find_invoice(id) Find invoice by ID

Return a single invoice

Parameters

Name Type Description Required Notes
id uuid::Uuid ID of the existing Lago Invoice [required]

Return type

crate::models::Invoice

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

refresh_invoice

crate::models::Invoice refresh_invoice(id) Refresh a draft invoice

Refresh a draft invoice

Parameters

Name Type Description Required Notes
id uuid::Uuid ID of the existing Lago Invoice [required]

Return type

crate::models::Invoice

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retry_payment

retry_payment(id) Retry invoice payment

Retry invoice payment

Parameters

Name Type Description Required Notes
id uuid::Uuid ID of the existing Lago Invoice [required]

Return type

(empty response body)

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_invoice

crate::models::Invoice update_invoice(id, invoice_input) Update an existing invoice status

Update an existing invoice

Parameters

Name Type Description Required Notes
id uuid::Uuid ID of the existing Lago Invoice [required]
invoice_input InvoiceInput Update an existing invoice [required]

Return type

crate::models::Invoice

Authorization

bearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]