billingo_api_v3
v3.0.14
Published
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__
Downloads
2
Readme
billingo_api_v3
BillingoApiV3 - JavaScript client for 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 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. This SDK is automatically generated by the Swagger Codegen project:
- API version: 3.0.14
- Package version: 3.0.14
- Build package: io.swagger.codegen.v3.generators.javascript.JavaScriptClientCodegen For more information, please visit https://www.billingo.hu/kapcsolat
Installation
For Node.js
npm
To publish the library as a npm, please follow the procedure in "Publishing npm packages".
Then install it via:
npm install billingo_api_v3 --save
git
If the library is hosted at a git repository, e.g. https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:
npm install GIT_USER_ID/GIT_REPO_ID --save
For browser
The library also works in the browser environment via npm and browserify. After following
the above steps with Node.js and installing browserify with npm install -g browserify
,
perform the following (assuming main.js is your entry file):
browserify main.js > bundle.js
Then include bundle.js in the HTML pages.
Webpack Configuration
Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:
module: {
rules: [
{
parser: {
amd: false
}
}
]
}
Getting Started
Please follow the installation instruction and execute the following JS code:
var BillingoApiV3 = require('billingo_api_v3');
var defaultClient = BillingoApiV3.ApiClient.instance;
// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-API-KEY'] = "Token"
var api = new BillingoApiV3.BankAccountApi()
var body = new BillingoApiV3.BankAccount(); // {BankAccount} BankAccount object that you would like to store.
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.createBankAccount(body, callback);
Documentation for API Endpoints
All URIs are relative to https://api.billingo.hu/v3
Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- BillingoApiV3.BankAccountApi | createBankAccount | POST /bank-accounts | Create a bank account BillingoApiV3.BankAccountApi | deleteBankAccount | DELETE /bank-accounts/{id} | Delete a bank account BillingoApiV3.BankAccountApi | getBankAccount | GET /bank-accounts/{id} | Retrieve a bank account BillingoApiV3.BankAccountApi | listBankAccount | GET /bank-accounts | List all bank account BillingoApiV3.BankAccountApi | updateBankAccount | PUT /bank-accounts/{id} | Update a bank account BillingoApiV3.CurrencyApi | getConversionRate | GET /currencies | Get currencies exchange rate. BillingoApiV3.DocumentApi | archiveDocument | PUT /documents/{id}/archive | Archive a proforma document. BillingoApiV3.DocumentApi | cancelDocument | POST /documents/{id}/cancel | Cancel a document BillingoApiV3.DocumentApi | createDocument | POST /documents | Create a document BillingoApiV3.DocumentApi | createDocumentFromDraft | PUT /documents/{id} | Converts a draft to an invoice. BillingoApiV3.DocumentApi | createDocumentFromProforma | POST /documents/{id}/create-from-proforma | Create a document from proforma. BillingoApiV3.DocumentApi | createModificationDocument | POST /documents/{id}/create-modification-document | Create a modification document. BillingoApiV3.DocumentApi | createReceipt | POST /documents/receipt | Create a receipt BillingoApiV3.DocumentApi | createReceiptFromDraft | PUT /documents/receipt/{id} | Converts a draft to a receipt. BillingoApiV3.DocumentApi | deleteDocument | DELETE /documents/{id} | Delete a draft. BillingoApiV3.DocumentApi | deletePayment | DELETE /documents/{id}/payments | Delete all payment history on document BillingoApiV3.DocumentApi | documentCopy | POST /documents/{id}/copy | Copy a document BillingoApiV3.DocumentApi | downloadDocument | GET /documents/{id}/download | Download a document in PDF format. BillingoApiV3.DocumentApi | getDocument | GET /documents/{id} | Retrieve a document BillingoApiV3.DocumentApi | getDocumentByVendorId | GET /documents/vendor/{vendor_id} | Retrieve a document by vendor id BillingoApiV3.DocumentApi | getOnlineSzamlaStatus | GET /documents/{id}/online-szamla | Retrieve a document Online Számla status BillingoApiV3.DocumentApi | getPayment | GET /documents/{id}/payments | Retrieve a payment histroy BillingoApiV3.DocumentApi | getPublicUrl | GET /documents/{id}/public-url | Retrieve a document download public url. BillingoApiV3.DocumentApi | listDocument | GET /documents | List all documents BillingoApiV3.DocumentApi | posPrint | GET /documents/{id}/print/pos | Returns a printable POS PDF BillingoApiV3.DocumentApi | sendDocument | POST /documents/{id}/send | Send invoice to given email adresses. BillingoApiV3.DocumentApi | updatePayment | PUT /documents/{id}/payments | Update payment history BillingoApiV3.DocumentBlockApi | listDocumentBlock | GET /document-blocks | List all document blocks BillingoApiV3.DocumentExportApi | create | POST /document-export | Create document export. BillingoApiV3.DocumentExportApi | download | GET /document-export/{id}/download | Return exported binary file. BillingoApiV3.DocumentExportApi | poll | GET /document-export/{id}/poll | Retrieve export state. BillingoApiV3.OrganizationApi | getOrganizationData | GET /organization | Retrieve a organization data. BillingoApiV3.PartnerApi | createPartner | POST /partners | Create a partner BillingoApiV3.PartnerApi | deletePartner | DELETE /partners/{id} | Delete a partner BillingoApiV3.PartnerApi | getPartner | GET /partners/{id} | Retrieve a partner BillingoApiV3.PartnerApi | listPartner | GET /partners | List all partners BillingoApiV3.PartnerApi | updatePartner | PUT /partners/{id} | Update a partner BillingoApiV3.ProductApi | createProduct | POST /products | Create a product BillingoApiV3.ProductApi | deleteProduct | DELETE /products/{id} | Delete a product BillingoApiV3.ProductApi | getProduct | GET /products/{id} | Retrieve a product BillingoApiV3.ProductApi | listProduct | GET /products | List all product BillingoApiV3.ProductApi | updateProduct | PUT /products/{id} | Update a product BillingoApiV3.SpendingApi | spendingDelete | DELETE /spendings/{id} | Deletes a spending. BillingoApiV3.SpendingApi | spendingList | GET /spendings | Lists all spending BillingoApiV3.SpendingApi | spendingSave | POST /spendings | Creates a new spending. BillingoApiV3.SpendingApi | spendingShow | GET /spendings/{id} | Retrieves one specific spending. BillingoApiV3.SpendingApi | spendingUpdate | PUT /spendings/{id} | Updates a spending item. BillingoApiV3.UtilApi | checkTaxNumber | GET /utils/check-tax-number/{tax_number} | Check tax number. BillingoApiV3.UtilApi | getId | GET /utils/convert-legacy-id/{id} | Convert legacy ID to v3 ID. BillingoApiV3.UtilApi | getServerTime | GET /utils/time | Get the server time
Documentation for Models
- BillingoApiV3.Address
- BillingoApiV3.BankAccount
- BillingoApiV3.BankAccountList
- BillingoApiV3.Category
- BillingoApiV3.CheckTaxNumberMessage
- BillingoApiV3.ClientError
- BillingoApiV3.ClientErrorResponse
- BillingoApiV3.ConversationRate
- BillingoApiV3.CorrectionType
- BillingoApiV3.Country
- BillingoApiV3.CreateDocumentExport
- BillingoApiV3.Currency
- BillingoApiV3.DateType
- BillingoApiV3.Discount
- BillingoApiV3.DiscountType
- BillingoApiV3.Document
- BillingoApiV3.DocumentAncestor
- BillingoApiV3.DocumentBankAccount
- BillingoApiV3.DocumentBlock
- BillingoApiV3.DocumentBlockList
- BillingoApiV3.DocumentBlockType
- BillingoApiV3.DocumentCancellation
- BillingoApiV3.DocumentExportFilterExtra
- BillingoApiV3.DocumentExportId
- BillingoApiV3.DocumentExportOtherOptions
- BillingoApiV3.DocumentExportQueryType
- BillingoApiV3.DocumentExportSortBy
- BillingoApiV3.DocumentExportStatus
- BillingoApiV3.DocumentExportStatusState
- BillingoApiV3.DocumentExportType
- BillingoApiV3.DocumentForm
- BillingoApiV3.DocumentFormat
- BillingoApiV3.DocumentInsert
- BillingoApiV3.DocumentInsertType
- BillingoApiV3.DocumentItem
- BillingoApiV3.DocumentItemData
- BillingoApiV3.DocumentLanguage
- BillingoApiV3.DocumentList
- BillingoApiV3.DocumentNotificationStatus
- BillingoApiV3.DocumentOrganization
- BillingoApiV3.DocumentPartner
- BillingoApiV3.DocumentProductData
- BillingoApiV3.DocumentPublicUrl
- BillingoApiV3.DocumentSettings
- BillingoApiV3.DocumentSummary
- BillingoApiV3.DocumentType
- BillingoApiV3.DocumentVatRateSummary
- BillingoApiV3.Entitlement
- BillingoApiV3.Feature
- BillingoApiV3.Id
- BillingoApiV3.InvoiceSettings
- BillingoApiV3.LedgerNumberInformation
- BillingoApiV3.ModificationDocumentInsert
- BillingoApiV3.OneOfDocumentInsertItemsItems
- BillingoApiV3.OneOfModificationDocumentInsertItemsItems
- BillingoApiV3.OneOfReceiptInsertItemsItems
- BillingoApiV3.OnlinePayment
- BillingoApiV3.OnlineSzamlaStatus
- BillingoApiV3.OnlineSzamlaStatusEnum
- BillingoApiV3.OnlineSzamlaStatusMessage
- BillingoApiV3.OrganizationData
- BillingoApiV3.Partner
- BillingoApiV3.PartnerCustomBillingSettings
- BillingoApiV3.PartnerList
- BillingoApiV3.PartnerTaxType
- BillingoApiV3.PaymentHistory
- BillingoApiV3.PaymentMethod
- BillingoApiV3.PaymentStatus
- BillingoApiV3.PaymentStatusSpending
- BillingoApiV3.Product
- BillingoApiV3.ProductList
- BillingoApiV3.ReceiptInsert
- BillingoApiV3.ReceiptItemData
- BillingoApiV3.ReceiptProductData
- BillingoApiV3.Round
- BillingoApiV3.SendDocument
- BillingoApiV3.ServerError
- BillingoApiV3.ServerErrorResponse
- BillingoApiV3.ServerTime
- BillingoApiV3.Source
- BillingoApiV3.Spending
- BillingoApiV3.SpendingList
- BillingoApiV3.SpendingListItem
- BillingoApiV3.SpendingPartner
- BillingoApiV3.SpendingPaymentMethod
- BillingoApiV3.SpendingSave
- BillingoApiV3.Subscription
- BillingoApiV3.SubscriptionErrorResponse
- BillingoApiV3.TaxNumber
- BillingoApiV3.TooManyRequestsResponse
- BillingoApiV3.UnitPriceType
- BillingoApiV3.ValidationError
- BillingoApiV3.ValidationErrorResponse
- BillingoApiV3.Vat
Documentation for Authorization
api_key
- Type: API key
- API key parameter name: X-API-KEY
- Location: HTTP header