Expand description
§Billecta-rs
Wrapper around the Billecta API.
§Creating a new client
Create a client using a URL and a token. See section Authentication in Getting Started
§Using environment variables
A client can be created using the environment variables:
BILLECTA_URL
BILLECTA_TOKEN
let client = billecta::Client::from_env();
§Creating a SecureToken
§1. Retreive SecureToken
To begin, encode your username and password as follows:
$ echo -n "<username>:<password>" | base64
$ base64 <<< "<username>:<password>"
cannot be used since it adds a newline.
§2. Retreive your SecureToken
Send the encoded b64-string to Billecta with the b64-string you just created in
the Authorization Header as such: Authorization: Basic <b64string>
curl -X "POST" https://api.billecta.com/v1/authentication/apiauthenticate -H "Content-Length:0" -H "Authorization: Basic <b64 string>" -H "Accept: application/json"
§3. Encode the SecureToken
Snatch the SecureToken from the returned data and encode it as b64 once more:
$ base64 <<< <SecureTokenString>
§4. Do API things
To try it out try to fetch all Creditor with the b64 encode SecureToken in the Authorization header
curl -X "POST" https://api.billecta.com/v1/creditors/creditors -H "Authorization: SecureToken <SecureTokenB64>"
Re-exports§
Modules§
- accounting
- Accounting
- accounting_
dimensions - Accounting dimensions
- bank
- Bank
- common
- Common
- contract_
invoice - Contract invoice
- cost_
centers - Cost Centers
- creditors
- Creditors
- debt_
collection - Debt collection
- debtors
- Debtors
- delivery
- Delivery
- files
- Files
- invoice
- Invoice
- notifications
- Notifications
- payments
- Payments
- products
- Products
- projects
- Projects
- reconciliation_
invoice - Reconciliation invoice
- search
- Search
- self_
invoice - Self invoice
- unstable
- users
- Users
Structs§
- Accounting
Dimension - Accounting
Export - Accounting
Export Creation - Accounting
Payment Mean - Accounting
Record - Accounting
Settings - Accounting
Settings Account - Accounting
Voucher Export Creation - Accounting
Voucher Record - Accounting
Voucher Transaction - Action
Public Ids - Action
Reference - AddMultiple
Debtors ToCategory Request - Amount
- Attest
Multiple Invoices Request - Autogiro
Payment Status - Autogiro
Withdrawal - Bank
Account - Bank
Account Request - Bank
IdAthentication - Bank
IdAuthentication Request - Bank
IdAuthentication Status - Bank
IdPhone Authentication Request - Bank
IdSign Request - Bank
IdSign Status - Billecta
Docs Additional Info - Billecta
Docs Hidden - Billecta
Docs Required - Card
Refund Payment - Checkout
Settings - Client
- Client
Config - Comment
Action - Common
Action Event - Configuration
- Configuration
Debt Collection - Configuration
Deviation Analysis - Configuration
Reminder - Contract
Invoice Action - Contract
Invoice Action Attachment - Contract
Invoice Action Event - Contract
Invoice Action Record - Contract
Invoice Action State - Contract
Invoice Action Sub - Cost
Center - Country
- Created
- Created
Multiple - Created
Url - Credit
Action - Credit
Card Add - Credit
Card AddIntent - Credit
Card Payment - Credit
Card Payment Intent - Credit
Card Withdrawal - Crediting
Invoice - Creditor
- Creditor
Access Right - Creditor
Addon - Creditor
Addon Category - Creditor
Bank Info - Creditor
Claims - Creditor
Claims Contact - Creditor
Contact - Creditor
Foreign Account - Creditor
Invoice Address - Creditor
Kyc - Creditor
KycForm - Creditor
KycForm Beneficial Owner - Creditor
KycForm Business Category - Creditor
KycForm Company - Creditor
KycForm Contact - Creditor
KycForm Owner - Creditor
KycForm UsPerson - Creditor
Outgoing Bankgiro - Creditor
Payment Method - Creditor
Setting - Creditor
Share - Creditor
Signatory Contact - Creditor
Sub - Creditor
Token - Currency
- Data
Stream - Date
- Date
Time - A Datetime using Stockholm as TZ. Either CET or CEST.
- Debenture
Action Entry - Debt
Collection Action - Debt
Collection Action Event - Debt
Collection Action Log - Debt
Collection Action State - Debt
Collection Action Sub - Debt
Collection Details - Debt
Collection Entry - Debt
Collection From Invoice Entry - Debt
Collection From Reconciliation Invoice Entry - Debt
Collection Invoice - Debt
Collection Message - Debtor
- Debtor
Autogiro - Debtor
Autogiro Approval - Debtor
Balance - Debtor
Category - Debtor
Credit Card - Debtor
Default Action Config - Debtor
Event - Debtor
Information Correction Request - Debtor
Kivra Status - Debtor
Self Invoice Info - Debtor
Unhandled External Payment - Debtors
ToMatch With Kivra - Default
Action Config - Delivery
Address Override - Dimension
Code - EInvoice
Registration - Empty
Response - Enum
Compability Default - Export
Files Request - External
Branding - File
- Generic
Action - Half
Yearly Autogiro Contract Invoice - Import
Invoice File - Import
Payment File - Incoming
Payment - Incoming
Payment Request - Installment
Plan Action Event - Installment
Plan Action From Debt Collection - Installment
Plan Action From Debt Collection Invoice - Installment
Plan Action From Debt Collection State - Installment
Plan Action Sub - Invoice
Account Receivable - Invoice
Action - Invoice
Action Attachment - Invoice
Action Commented - Invoice
Action Entry - Invoice
Action Event - Invoice
Action Invoice - Invoice
Action Record - Invoice
Action RotRut Processed - Invoice
Action State - Invoice
Action Sub - Invoice
Bookkeeping Override - Invoice
Delivery Status - Invoice
File - Invoice
Import File Job - Invoice
Plan - Locked
Period - Mail
Delivery - Monthly
Autogiro Contract Invoice - Monthly
Recurrence - Notification
Event - Notification
Receiver - Notification
Receiver Setting - Open
Action Request - Order
Action - Order
Action Address - Order
Action Debtor - Order
Action Entry - Order
Action Record - Order
Action State - Order
Checkout - Order
Checkout Intent - Outgoing
Payment - Outgoing
Payment Status - Overpayment
Details - Password
- Payment
Advice Action Entry - Payment
Match - Payment
Match Result - Payment
Override - Peppol
Participant - Product
- Product
Price - Products
Template - Project
- Quarterly
Recurrence - Reconciiation
Invoice Action Event - Reconciliation
Debtor - Reconciliation
Invoice Action - Reconciliation
Invoice Action Entry - Reconciliation
Invoice Action Reminder - Reconciliation
Invoice Action State - Reconciliation
Invoice Action Sub - Recurrence
Details - Register
Payment - Register
Reconciliation Payment - Register
Self Invoice Payment - Register
Supplier Invoice Payment - Reminder
Invoice Action - Reminder
Invoice Action Invoice - Reminder
Invoice Action Sub - Reminder
Invoice Details - Repay
Unhandled Payment - Request
- ReverseVAT
Details - RotRut
Customer - RotRut
Details - Search
- Search
Result - Secure
Token - Self
Invoice Action - Self
Invoice Action Attachment - Self
Invoice Action Entry - Self
Invoice Action Event - Self
Invoice Action Invoice - Self
Invoice Action Record - Self
Invoice Action State - Self
Invoice Action Sub - Self
Invoice Payment - Send
Reconciliation Invoice Reminder - Send
Reminder Invoice - Sender
Payment Info - SmsDelivery
- Stream
- Supplier
Invoice Action Sub - Swish
Payment Intent - Swish
Payment Status - Swish
Refund Payment - Swish
Settings - Text
Template - TwoFactor
Bank Id - Unhandled
Payment - Update
Address Action - User
- User
Claims - User
Right - User
Subscribed Invoice - UtcDate
Time Converter - Uuid
- A Universally Unique Identifier (UUID).
- Verification
Invoice Action Entry - Webhook
Creditor Share - Webhook
Header - Webhook
Setting - Webhook
Trigger - Yearly
Autogiro Contract Invoice - Yearly
Recurrence
Enums§
- Accounting
Export Date Selection Type - Accounting
Export Format Type - Accounting
Record Type - Accounting
Settings Account Type - Action
Search Status Type - Action
Source Type - Action
Type - Activation
Policy Type - Autogiro
Approval Comment Code - Autogiro
Compatible Type - Autogiro
Payment Status Type - Autogiro
Stage Type - Autogiro
Withdrawal Comment Code - Bank
Account Bank Type - Bank
Account Status Type - Bank
IdHint Code Type - Bank
IdStatus Type - Book
Keeping Method - Comment
Target Type - Contract
Invoice Action Stage Type - Contract
Invoice Period Rule Type - Credit
Card AddStatus Type - Credit
Card Payment Status Type - Creditor
Addon Category Type - Creditor
Addon Description Type - Creditor
Addon Type - Creditor
KycState Type - Creditor
Module Access Type - Creditor
Payment Method Priority Type - Creditor
Payment Method Type - Creditor
Share Target Type - Currency
Code - Debt
Collection Action Level Type - Debt
Collection Action Stage Type - Debtor
Balance Type - Debtor
Contract Period Type - Debtor
Contract State Type - Debtor
Payment Method - Debtor
Type - Delivery
Method Type - Delivery
Status Type - Discount
Type - EInvoice
Bank Type - Error
- Event
Type - Fiscal
Year Type - Generic
Action Stage Type - Import
File State Type - Incoming
Payment Notification Method Type - Installment
Plan Action Stage Type - Installment
Plan Source Type - Interest
Type - Intermediator
Type - Invoice
Action Stage Type - Kivra
Status Type - KycOwnership
Level Type - Language
Type - Order
Checkout Status Type - Order
Payment Method Type - Order
Record Type - Order
Stage Type - Origin
Type - Outgoing
Payment Status Type - Outgoing
Payment Type - P27Category
Purpose Type - P27Charge
Bearer Type - P27Code
Type - P27Method
Type - Payment
Frequency Type - Postage
Type - Product
Type - Project
Status Type - Receiving
Account Type - Receiving
Payment Method Type - Reconciliation
Invoice Action Stage Type - Record
Type - Recurrence
Interval Type - Reference
Type - Register
Payment Over Shooting Amount Handling Type - RotRut
Search Filter Type - RotRut
Type - Self
Invoice Action Stage Type - SieKPTYP
Type - Stripe
Account Type - Supplier
Invoice Action Stage Type - Supplier
Payment Method Type - Swish
Payment Status Type - Swish
Status Type - Unhandled
Payment State Type - Unhandled
Payment Type - Webhook
Trigger Type
Traits§
Type Aliases§
- Accounting
Dimensions - Accounting
Exports - Accounting
Payment Means - Accounting
Records - Accounting
Voucher Records - Action
References - Autogiro
Payment Statuses - Common
Action Events - Configurations
- Contract
Invoice Action Subs - Cost
Centers - Countries
- Credit
Card Payments - Creditor
Addons - Creditor
Settings - Creditor
Shares - Creditor
Subs - Creditors
- Currencies
- Debt
Collection Action Logs - Debt
Collection Action Subs - Debt
Collection Actions - Debt
Collection Messages - Debtor
Autogiro Approvals - Debtor
Balances - Debtor
Categories - Debtor
Events - Debtors
- Files
- Import
Invoice File Jobs - Incoming
Payments - Installment
Plan Action Subs - Installment
Plan Actions From Debt Collection - Invoice
Account Receivables - Invoice
Action RotRut Processeds - Invoice
Action Subs - Invoice
Actions - Notification
Events - Notification
Receivers - Outgoing
Payment Statuses - Peppol
Participants - Projects
- Reconciliation
Invoice Action Subs - Reconciliation
Invoice Actions - Reminder
Invoice Action Subs - Reminder
Invoice Actions - Result
- Text
Rows - Unhandled
Payments - User
Subscribed Invoices - Users