#billing #api-client #customer #p7m #oauth #payment #http-request

p7m-billing

Rust bindings for the billing API of P7M

1 unstable release

0.1.1 Jul 7, 2024

#1262 in Web programming

24 downloads per month

Apache-2.0

60KB
938 lines

Rust API client for p7m-billing

API for managing billing of customers

The purpose of this API is to manage customers, articles, recurring billing, and payments.

The caller has to be authenticated with the system and provide a JWT token in the Authorization header of the HTTP request. When using the API you typically get this token by authenticating first with OAuth 2.0.

When you are trying this API using the Swagger interface, you need to click the Authorize button and then again the Authorize button in the pop-up that gets opened.

Overview

This API client was generated by the OpenAPI Generator project. By using the openapi-spec from a remote server, you can easily generate an API client.

  • API version: 0.1.1
  • Package version: 0.1.1
  • Build package: org.openapitools.codegen.languages.RustClientCodegen

Installation

Put the package under your project folder in a directory named p7m-billing and add the following to Cargo.toml under [dependencies]:

p7m-billing = { path = "./p7m-billing" }

Documentation for API Endpoints

All URIs are relative to https://billing.api.p7m.de/v1

Class Method HTTP request Description
BankAccountApi get_bank_accounts GET /bankaccounts Get a list of all bank accounts
BankAccountApi post_bank_accounts POST /bankaccounts Create a new bank account
CustomerApi get_customers GET /customers Get a list of all customers
CustomerApi get_customers_id GET /customers/{customer_id} Request a single customer by its ID
CustomerApi post_customers POST /customers Create a new customer
CustomerApi pub_customers_id PUT /customers/{customer_id} Update an existing customer
InvoiceApi get_currencies GET /currencies Get a list of all (available) currencies
InvoiceApi get_invoices GET /invoices Get a list of all invoices
InvoiceApi get_invoices_id GET /invoices/{invoice_id} Get a single invoice by its ID
InvoiceApi post_invoices POST /invoices Create a new invoice
InvoiceApi post_invoices_invoice_id POST /invoices/{invoice_id} Create a new invoice position

Documentation For Models

To get access to the crate's generated documentation, use:

cargo doc --open

Author

tech@p7m.de

Dependencies

~4–15MB
~224K SLoC