Billingo API v3
This is a Billingo API v3 documentation. Our API based on REST software architectural style. API has resource-oriented URLs, accepts JSON-encoded request…
Finance & banking#openapi#financial
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
This is a Billingo API v3 documentation. Our API based on REST software architectural style. API has resource-oriented URLs, accepts JSON-encoded request bodies and returns JSON-encoded responses. To use this API you have to generate a new API key on our site. After that, you can test your API key on this page.
Endpoints 31
Document
- GETList all documents
/documents?page=1&per_page=25&block_id=0&partner_id=0&payment_method=cash&payment_status=paid&start_date=2020-05-15&end_date=2020-05-15&start_number=1&end_number=10&start_year=2020&end_year=2020Returns a list of your documents. The documents are returned sorted by creation date, with the most recent documents appearing first. - POSTCreate a document
/documentsCreate a new document. Returns a document object if the create is succeded. - GETRetrieve a document
/documents/:idRetrieves the details of an existing document. - POSTCancel a document
/documents/:id/cancelCancel a document. Returns a cancellation document object if the cancellation is succeded. - POSTCreate a document from proforma.
/documents/:id/create-from-proformaCreate a new document from proforma. Returns a document object if the create is succeded. - GETDownload a document in PDF format.
/documents/:id/downloadDownload a document. Returns a document in PDF format. - GETRetrieve a document Online Számla status
/documents/:id/online-szamlaRetrieves the details of an existing document status. - GETRetrieve a payment histroy
/documents/:id/paymentsRetrieves the details of payment history an existing document. - PUTUpdate payment history
/documents/:id/paymentsUpdate payment history an existing document. Returns a payment history object if the update is succeded. - DELETEDelete all payment history on document
/documents/:id/paymentsDelete all exist payment history on document. - GETRetrieve a document download public url.
/documents/:id/public-urlRetrieves public url to download an existing document. - POSTSend invoice to given email adresses.
/documents/:id/sendReturns a list of emails, where the invoice is sent.
DocumentBlock
- GETList all document blocks
/document-blocks?page=1&per_page=25Returns a list of your document blocks. The document blocks are returned sorted by creation date, with the most recent document blocks appearing first.
Partner
- GETList all partners
/partners?page=1&per_page=25Returns a list of your partners. The partners are returned sorted by creation date, with the most recent partners appearing first. - POSTCreate a partner
/partnersCreate a new partner. Returns a partner object if the create is succeded. - GETRetrieve a partner
/partners/:idRetrieves the details of an existing partner. - PUTUpdate a partner
/partners/:idUpdate an existing partner. Returns a partner object if the update is succeded. - DELETEDelete a partner
/partners/:idDelete an existing partner.
Product
- GETList all product
/products?page=1&per_page=25Returns a list of your products. The partners are returned sorted by creation date, with the most recent partners appearing first. - POSTCreate a product
/productsCreate a new product. Returns a product object if the create is succeded. - GETRetrieve a product
/products/:idRetrieves the details of an existing product. - PUTUpdate a product
/products/:idUpdate an existing product. Returns a product object if the update is succeded. - DELETEDelete a product
/products/:idDelete an existing product.
BankAccount
- GETList all bank account
/bank-accounts?page=1&per_page=25Returns a list of your bank accounts. The bank accounts are returned sorted by creation date, with the most recent bank account appearing first. - POSTCreate a bank account
/bank-accountsCreate a new bank account. Returns a bank account object if the create is succeded. - GETRetrieve a bank account
/bank-accounts/:idRetrieves the details of an existing bank account. - PUTUpdate a bank account
/bank-accounts/:idUpdate an existing bank accounts. Returns a bank account object if the update is succeded. - DELETEDelete a bank account
/bank-accounts/:idDelete an existing bank account.
Currency
- GETGet currencies exchange rate.
/currencies?from=AUD&to=AUDReturn with the exchange value of given currencies.
Organization
- GETRetrieve a organization data.
/organizationRetrieves the data of organization.
Util
- GETConvert legacy ID to v3 ID.
/utils/convert-legacy-id/:idRetrieves the API v3 ID.
API details
- Base URL
https://api.billingo.hu/v3- Authentication
- An API key in the X-API-KEY header
- Operations
- 31 operations on 19 pathsGET 16POST 7PUT 4DELETE 4
- Main resources
- Document 12BankAccount 5Partner 5Product 5Currency 1DocumentBlock 1Organization 1Util 1
- Response formats
application/jsonapplication/pdf- Description format
- OpenAPI 3.0.0, API version
3.0.7 - Links
- Documentation · OpenAPI document · Terms of service · Support
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the Billingo API v3 in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Billingo API v3 collection, without the publisher's secrets.
- Add your credentialsThis API uses an API key in the X-API-KEY header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “List all documents” (GET /documents?page=1&per_page=25&block_id=0&partner_id=0&payment_method=cash&payment_status=paid&start_date=2020-05-15&end_date=2020-05-15&start_number=1&end_number=10&start_year=2020&end_year=2020), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Billingo API v3?
This is a Billingo API v3 documentation. Our API based on REST software architectural style. API has resource-oriented URLs, accepts JSON-encoded request… It is listed under Finance & banking and has 31 endpoints.
Who publishes the Billingo API v3?
It is listed from Billingo's public API description (an OpenAPI document), not published by Billingo on Swastik Codes. Anyone who controls billingo.hu can claim the profile by adding a DNS TXT record.
What is the base URL of the Billingo API v3?
Requests go to https://api.billingo.hu/v3. Endpoint paths are added to this base URL.
How do I authenticate with the Billingo API v3?
With an API key in the X-API-KEY header.
How many endpoints does the Billingo API v3 have?
31 operations on 19 paths (16 GET, 7 POST, 4 PUT, 4 DELETE). The largest groups are Document, BankAccount, Partner, Product.
Is forking the Billingo API v3 free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.