openapi-directory
Version:
Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS
1 lines • 63.4 kB
JSON
{"openapi":"3.0.0","servers":[{"description":"Billingo API","url":"https://api.billingo.hu/v3"}],"info":{"contact":{"email":"hello@billingo.hu","name":"Billingo Support","url":"https://www.billingo.hu/kapcsolat"},"description":"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](https://app.billingo.hu/api-key). After that, you can test your API key on this page.","termsOfService":"https://www.billingo.hu/felhasznalasi-feltetelek","title":"Billingo API v3","version":"3.0.7","x-apisguru-categories":["financial"],"x-logo":{"url":"https://www.billingo.hu/images/billingo_logo.svg"},"x-origin":[{"format":"openapi","url":"https://api.swaggerhub.com/apis/Billingo/Billingo/3.0.7","version":"3.0"}],"x-providerName":"billingo.hu"},"externalDocs":{"description":"Find out more information about Billingo API v3 usage.","url":"https://support.billingo.hu/content/446136358"},"security":[{"api_key":[]}],"tags":[{"description":"Document object represents your invoice.","name":"Document"},{"description":"DocumentBlock object represents your invoice pad.","name":"DocumentBlock"},{"description":"Partner object represents your client.","name":"Partner"},{"description":"Product object represents your document's product.","name":"Product"},{"description":"BankAccount object represents your bank account information.","name":"BankAccount"}],"paths":{"/bank-accounts":{"get":{"description":"Returns a list of your bank accounts. The bank accounts are returned sorted by creation date, with the most recent bank account appearing first.","operationId":"ListBankAccount","parameters":[{"in":"query","name":"page","required":false,"schema":{"default":"1","type":"integer"}},{"in":"query","name":"per_page","required":false,"schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BankAccountList"}}},"description":"Success response","headers":{"Retry-After":{"description":"How many seconds you have to wait before making new request.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Limit":{"description":"Request limit per minute.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Remaining":{"description":"The number of requests left for the time window.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Reset":{"description":"The timestamp at which the current rate limit window resets.","schema":{"format":"int32","type":"integer"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"500":{"$ref":"#/components/responses/ServerError"}},"summary":"List all bank account","tags":["BankAccount"]},"post":{"description":"Create a new bank account. Returns a bank account object if the create is succeded.","operationId":"CreateBankAccount","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BankAccount"}}},"description":"BankAccount object that you would like to store.","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BankAccount"}}},"description":"BankAccount created successfully.","headers":{"Retry-After":{"description":"How many seconds you have to wait before making new request.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Limit":{"description":"Request limit per minute.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Remaining":{"description":"The number of requests left for the time window.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Reset":{"description":"The timestamp at which the current rate limit window resets.","schema":{"format":"int32","type":"integer"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"500":{"$ref":"#/components/responses/ServerError"}},"summary":"Create a bank account","tags":["BankAccount"]}},"/bank-accounts/{id}":{"delete":{"description":"Delete an existing bank account.","operationId":"DeleteBankAccount","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Bank account deleted successfully.","headers":{"Retry-After":{"description":"How many seconds you have to wait before making new request.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Limit":{"description":"Request limit per minute.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Remaining":{"description":"The number of requests left for the time window.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Reset":{"description":"The timestamp at which the current rate limit window resets.","schema":{"format":"int32","type":"integer"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/ServerError"}},"summary":"Delete a bank account","tags":["BankAccount"]},"get":{"description":"Retrieves the details of an existing bank account.","operationId":"GetBankAccount","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BankAccount"}}},"description":"Success response","headers":{"Retry-After":{"description":"How many seconds you have to wait before making new request.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Limit":{"description":"Request limit per minute.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Remaining":{"description":"The number of requests left for the time window.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Reset":{"description":"The timestamp at which the current rate limit window resets.","schema":{"format":"int32","type":"integer"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"500":{"$ref":"#/components/responses/ServerError"}},"summary":"Retrieve a bank account","tags":["BankAccount"]},"put":{"description":"Update an existing bank accounts. Returns a bank account object if the update is succeded.","operationId":"UpdateBankAccount","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BankAccount"}}},"description":"Bank account object that you would like to update.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BankAccount"}}},"description":"Bank account updated successfully.","headers":{"Retry-After":{"description":"How many seconds you have to wait before making new request.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Limit":{"description":"Request limit per minute.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Remaining":{"description":"The number of requests left for the time window.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Reset":{"description":"The timestamp at which the current rate limit window resets.","schema":{"format":"int32","type":"integer"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"500":{"$ref":"#/components/responses/ServerError"}},"summary":"Update a bank account","tags":["BankAccount"]}},"/currencies":{"get":{"description":"Return with the exchange value of given currencies.","operationId":"GetConversionRate","parameters":[{"in":"query","name":"from","required":true,"schema":{"$ref":"#/components/schemas/Currency"}},{"in":"query","name":"to","required":true,"schema":{"$ref":"#/components/schemas/Currency"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConversationRate"}}},"description":"Currencies exchange rate returned.","headers":{"Retry-After":{"description":"How many seconds you have to wait before making new request.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Limit":{"description":"Request limit per minute.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Remaining":{"description":"The number of requests left for the time window.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Reset":{"description":"The timestamp at which the current rate limit window resets.","schema":{"format":"int32","type":"integer"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"500":{"$ref":"#/components/responses/ServerError"}},"summary":"Get currencies exchange rate.","tags":["Currency"]}},"/document-blocks":{"get":{"description":"Returns a list of your document blocks. The document blocks are returned sorted by creation date, with the most recent document blocks appearing first.","operationId":"ListDocumentBlock","parameters":[{"in":"query","name":"page","required":false,"schema":{"default":"1","type":"integer"}},{"in":"query","name":"per_page","required":false,"schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentBlockList"}}},"description":"Success response","headers":{"Retry-After":{"description":"How many seconds you have to wait before making new request.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Limit":{"description":"Request limit per minute.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Remaining":{"description":"The number of requests left for the time window.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Reset":{"description":"The timestamp at which the current rate limit window resets.","schema":{"format":"int32","type":"integer"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"500":{"$ref":"#/components/responses/ServerError"}},"summary":"List all document blocks","tags":["DocumentBlock"]}},"/documents":{"get":{"description":"Returns a list of your documents. The documents are returned sorted by creation date, with the most recent documents appearing first.","operationId":"ListDocument","parameters":[{"in":"query","name":"page","required":false,"schema":{"default":"1","type":"integer"}},{"in":"query","name":"per_page","required":false,"schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Filter documents by the identifier of your DocumentBlock.","in":"query","name":"block_id","required":false,"schema":{"type":"integer"}},{"description":"Filter documents by the identifier of your Partner.","in":"query","name":"partner_id","required":false,"schema":{"type":"integer"}},{"description":"Filter documents by PaymentMethod value.","example":"cash","in":"query","name":"payment_method","required":false,"schema":{"$ref":"#/components/schemas/PaymentMethod"}},{"description":"Filter documents by PaymentStatus value.","example":"paid","in":"query","name":"payment_status","required":false,"schema":{"$ref":"#/components/schemas/PaymentStatus"}},{"description":"Filter documents by date.","example":"2025-04-15T13:50:44.611Z","in":"query","name":"start_date","required":false,"schema":{"format":"date","type":"string"}},{"description":"Filter documents by date.","example":"2025-04-15T13:50:44.611Z","in":"query","name":"end_date","required":false,"schema":{"format":"date","type":"string"}},{"description":"Starting number of the document, should not contain year or any other formatting. Required if `start_year` given","example":"1","in":"query","name":"start_number","required":false,"schema":{"type":"integer"}},{"description":"Ending number of the document, should not contain year or any other formatting. Required if `end_year` given","example":"10","in":"query","name":"end_number","required":false,"schema":{"type":"integer"}},{"description":"Year for `start_number` parameter. Required if `start_number` given.","example":"2020","in":"query","name":"start_year","required":false,"schema":{"type":"integer"}},{"description":"Year for `end_number` parameter. Required if `end_number` given.","example":"2020","in":"query","name":"end_year","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentList"}}},"description":"Success response","headers":{"Retry-After":{"description":"How many seconds you have to wait before making new request.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Limit":{"description":"Request limit per minute.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Remaining":{"description":"The number of requests left for the time window.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Reset":{"description":"The timestamp at which the current rate limit window resets.","schema":{"format":"int32","type":"integer"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"500":{"$ref":"#/components/responses/ServerError"}},"summary":"List all documents","tags":["Document"]},"post":{"description":"Create a new document. Returns a document object if the create is succeded.","operationId":"CreateDocument","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentInsert"}}},"description":"DocumentInsert object that you would like to store.","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Document"}}},"description":"Document created successfully.","headers":{"Retry-After":{"description":"How many seconds you have to wait before making new request.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Limit":{"description":"Request limit per minute.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Remaining":{"description":"The number of requests left for the time window.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Reset":{"description":"The timestamp at which the current rate limit window resets.","schema":{"format":"int32","type":"integer"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"500":{"$ref":"#/components/responses/ServerError"}},"summary":"Create a document","tags":["Document"]}},"/documents/{id}":{"get":{"description":"Retrieves the details of an existing document.","operationId":"GetDocument","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Document"}}},"description":"Success response","headers":{"Retry-After":{"description":"How many seconds you have to wait before making new request.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Limit":{"description":"Request limit per minute.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Remaining":{"description":"The number of requests left for the time window.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Reset":{"description":"The timestamp at which the current rate limit window resets.","schema":{"format":"int32","type":"integer"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"500":{"$ref":"#/components/responses/ServerError"}},"summary":"Retrieve a document","tags":["Document"]}},"/documents/{id}/cancel":{"post":{"description":"Cancel a document. Returns a cancellation document object if the cancellation is succeded.","operationId":"CancelDocument","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Document"}}},"description":"Document cancellation successfully. Cancel document returned.","headers":{"Retry-After":{"description":"How many seconds you have to wait before making new request.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Limit":{"description":"Request limit per minute.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Remaining":{"description":"The number of requests left for the time window.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Reset":{"description":"The timestamp at which the current rate limit window resets.","schema":{"format":"int32","type":"integer"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"500":{"$ref":"#/components/responses/ServerError"}},"summary":"Cancel a document","tags":["Document"]}},"/documents/{id}/create-from-proforma":{"post":{"description":"Create a new document from proforma. Returns a document object if the create is succeded.","operationId":"CreateDocumentFromProforma","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Document"}}},"description":"Document created successfully.","headers":{"Retry-After":{"description":"How many seconds you have to wait before making new request.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Limit":{"description":"Request limit per minute.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Remaining":{"description":"The number of requests left for the time window.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Reset":{"description":"The timestamp at which the current rate limit window resets.","schema":{"format":"int32","type":"integer"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"500":{"$ref":"#/components/responses/ServerError"}},"summary":"Create a document from proforma.","tags":["Document"]}},"/documents/{id}/download":{"get":{"description":"Download a document. Returns a document in PDF format.","operationId":"DownloadDocument","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/pdf":{"schema":{"format":"binary","type":"string"}}},"description":"Document PDF file.","headers":{"Retry-After":{"description":"How many seconds you have to wait before making new request.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Limit":{"description":"Request limit per minute.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Remaining":{"description":"The number of requests left for the time window.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Reset":{"description":"The timestamp at which the current rate limit window resets.","schema":{"format":"int32","type":"integer"}}}},"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientError"}}},"description":"Document PDF has not generated yet. You should try to download again later.","headers":{"Retry-After":{"description":"How many seconds you have to wait before making new request.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Limit":{"description":"Request limit per minute.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Remaining":{"description":"The number of requests left for the time window.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Reset":{"description":"The timestamp at which the current rate limit window resets.","schema":{"format":"int32","type":"integer"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"500":{"$ref":"#/components/responses/ServerError"}},"summary":"Download a document in PDF format.","tags":["Document"]}},"/documents/{id}/online-szamla":{"get":{"description":"Retrieves the details of an existing document status.","operationId":"GetOnlineSzamlaStatus","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OnlineSzamlaStatus"}}},"description":"Success response","headers":{"Retry-After":{"description":"How many seconds you have to wait before making new request.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Limit":{"description":"Request limit per minute.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Remaining":{"description":"The number of requests left for the time window.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Reset":{"description":"The timestamp at which the current rate limit window resets.","schema":{"format":"int32","type":"integer"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"500":{"$ref":"#/components/responses/ServerError"}},"summary":"Retrieve a document Online Számla status","tags":["Document"]}},"/documents/{id}/payments":{"delete":{"description":"Delete all exist payment history on document.","operationId":"DeletePayment","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/PaymentHistory"},"type":"array"}}},"description":"Payment history deleted successfully.","headers":{"Retry-After":{"description":"How many seconds you have to wait before making new request.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Limit":{"description":"Request limit per minute.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Remaining":{"description":"The number of requests left for the time window.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Reset":{"description":"The timestamp at which the current rate limit window resets.","schema":{"format":"int32","type":"integer"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/ServerError"}},"summary":"Delete all payment history on document","tags":["Document"]},"get":{"description":"Retrieves the details of payment history an existing document.","operationId":"GetPayment","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/PaymentHistory"},"type":"array"}}},"description":"Success response","headers":{"Retry-After":{"description":"How many seconds you have to wait before making new request.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Limit":{"description":"Request limit per minute.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Remaining":{"description":"The number of requests left for the time window.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Reset":{"description":"The timestamp at which the current rate limit window resets.","schema":{"format":"int32","type":"integer"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"500":{"$ref":"#/components/responses/ServerError"}},"summary":"Retrieve a payment histroy","tags":["Document"]},"put":{"description":"Update payment history an existing document. Returns a payment history object if the update is succeded.","operationId":"UpdatePayment","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/PaymentHistory"},"type":"array"}}},"description":"Payment history object that you would like to update.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/PaymentHistory"},"type":"array"}}},"description":"Payment history updated successfully.","headers":{"Retry-After":{"description":"How many seconds you have to wait before making new request.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Limit":{"description":"Request limit per minute.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Remaining":{"description":"The number of requests left for the time window.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Reset":{"description":"The timestamp at which the current rate limit window resets.","schema":{"format":"int32","type":"integer"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"500":{"$ref":"#/components/responses/ServerError"}},"summary":"Update payment history","tags":["Document"]}},"/documents/{id}/public-url":{"get":{"description":"Retrieves public url to download an existing document.","operationId":"GetPublicUrl","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentPublicUrl"}}},"description":"Success response","headers":{"Retry-After":{"description":"How many seconds you have to wait before making new request.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Limit":{"description":"Request limit per minute.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Remaining":{"description":"The number of requests left for the time window.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Reset":{"description":"The timestamp at which the current rate limit window resets.","schema":{"format":"int32","type":"integer"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"500":{"$ref":"#/components/responses/ServerError"}},"summary":"Retrieve a document download public url.","tags":["Document"]}},"/documents/{id}/send":{"post":{"description":"Returns a list of emails, where the invoice is sent.","operationId":"SendDocument","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendDocument"}}},"description":"List of email-s where you want to send the invoice.","required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendDocument"}}},"description":"List of email adresses where the invoice sent.","headers":{"Retry-After":{"description":"How many seconds you have to wait before making new request.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Limit":{"description":"Request limit per minute.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Remaining":{"description":"The number of requests left for the time window.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Reset":{"description":"The timestamp at which the current rate limit window resets.","schema":{"format":"int32","type":"integer"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"500":{"$ref":"#/components/responses/ServerError"}},"summary":"Send invoice to given email adresses.","tags":["Document"]}},"/organization":{"get":{"description":"Retrieves the data of organization.","operationId":"GetOrganizationData","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationData"}}},"description":"Success response","headers":{"Retry-After":{"description":"How many seconds you have to wait before making new request.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Limit":{"description":"Request limit per minute.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Remaining":{"description":"The number of requests left for the time window.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Reset":{"description":"The timestamp at which the current rate limit window resets.","schema":{"format":"int32","type":"integer"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"500":{"$ref":"#/components/responses/ServerError"}},"summary":"Retrieve a organization data.","tags":["Organization"]}},"/partners":{"get":{"description":"Returns a list of your partners. The partners are returned sorted by creation date, with the most recent partners appearing first.","operationId":"ListPartner","parameters":[{"in":"query","name":"page","required":false,"schema":{"default":"1","type":"integer"}},{"in":"query","name":"per_page","required":false,"schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerList"}}},"description":"Success response","headers":{"Retry-After":{"description":"How many seconds you have to wait before making new request.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Limit":{"description":"Request limit per minute.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Remaining":{"description":"The number of requests left for the time window.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Reset":{"description":"The timestamp at which the current rate limit window resets.","schema":{"format":"int32","type":"integer"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"500":{"$ref":"#/components/responses/ServerError"}},"summary":"List all partners","tags":["Partner"]},"post":{"description":"Create a new partner. Returns a partner object if the create is succeded.","operationId":"CreatePartner","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerUpsert"}}},"description":"PartnerUpsert object that you would like to store.","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Partner"}}},"description":"Partner created successfully.","headers":{"Retry-After":{"description":"How many seconds you have to wait before making new request.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Limit":{"description":"Request limit per minute.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Remaining":{"description":"The number of requests left for the time window.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Reset":{"description":"The timestamp at which the current rate limit window resets.","schema":{"format":"int32","type":"integer"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"500":{"$ref":"#/components/responses/ServerError"}},"summary":"Create a partner","tags":["Partner"]}},"/partners/{id}":{"delete":{"description":"Delete an existing partner.","operationId":"DeletePartner","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Partner deleted successfully.","headers":{"Retry-After":{"description":"How many seconds you have to wait before making new request.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Limit":{"description":"Request limit per minute.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Remaining":{"description":"The number of requests left for the time window.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Reset":{"description":"The timestamp at which the current rate limit window resets.","schema":{"format":"int32","type":"integer"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/ServerError"}},"summary":"Delete a partner","tags":["Partner"]},"get":{"description":"Retrieves the details of an existing partner.","operationId":"GetPartner","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Partner"}}},"description":"Success response","headers":{"Retry-After":{"description":"How many seconds you have to wait before making new request.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Limit":{"description":"Request limit per minute.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Remaining":{"description":"The number of requests left for the time window.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Reset":{"description":"The timestamp at which the current rate limit window resets.","schema":{"format":"int32","type":"integer"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"500":{"$ref":"#/components/responses/ServerError"}},"summary":"Retrieve a partner","tags":["Partner"]},"put":{"description":"Update an existing partner. Returns a partner object if the update is succeded.","operationId":"UpdatePartner","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerUpsert"}}},"description":"Partner object that you would like to update.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Partner"}}},"description":"Partner updated successfully.","headers":{"Retry-After":{"description":"How many seconds you have to wait before making new request.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Limit":{"description":"Request limit per minute.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Remaining":{"description":"The number of requests left for the time window.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Reset":{"description":"The timestamp at which the current rate limit window resets.","schema":{"format":"int32","type":"integer"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"500":{"$ref":"#/components/responses/ServerError"}},"summary":"Update a partner","tags":["Partner"]}},"/products":{"get":{"description":"Returns a list of your products. The partners are returned sorted by creation date, with the most recent partners appearing first.","operationId":"ListProduct","parameters":[{"in":"query","name":"page","required":false,"schema":{"default":"1","type":"integer"}},{"in":"query","name":"per_page","required":false,"schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductList"}}},"description":"Success response","headers":{"Retry-After":{"description":"How many seconds you have to wait before making new request.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Limit":{"description":"Request limit per minute.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Remaining":{"description":"The number of requests left for the time window.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Reset":{"description":"The timestamp at which the current rate limit window resets.","schema":{"format":"int32","type":"integer"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"500":{"$ref":"#/components/responses/ServerError"}},"summary":"List all product","tags":["Product"]},"post":{"description":"Create a new product. Returns a product object if the create is succeded.","operationId":"CreateProduct","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Product"}}},"description":"Product object that you would like to store.","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Product"}}},"description":"Product created successfully.","headers":{"Retry-After":{"description":"How many seconds you have to wait before making new request.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Limit":{"description":"Request limit per minute.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Remaining":{"description":"The number of requests left for the time window.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Reset":{"description":"The timestamp at which the current rate limit window resets.","schema":{"format":"int32","type":"integer"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"500":{"$ref":"#/components/responses/ServerError"}},"summary":"Create a product","tags":["Product"]}},"/products/{id}":{"delete":{"description":"Delete an existing product.","operationId":"DeleteProduct","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Product deleted successfully.","headers":{"Retry-After":{"description":"How many seconds you have to wait before making new request.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Limit":{"description":"Request limit per minute.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Remaining":{"description":"The number of requests left for the time window.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Reset":{"description":"The timestamp at which the current rate limit window resets.","schema":{"format":"int32","type":"integer"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/ServerError"}},"summary":"Delete a product","tags":["Product"]},"get":{"description":"Retrieves the details of an existing product.","operationId":"GetProduct","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Product"}}},"description":"Success response","headers":{"Retry-After":{"description":"How many seconds you have to wait before making new request.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Limit":{"description":"Request limit per minute.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Remaining":{"description":"The number of requests left for the time window.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Reset":{"description":"The timestamp at which the current rate limit window resets.","schema":{"format":"int32","type":"integer"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"500":{"$ref":"#/components/responses/ServerError"}},"summary":"Retrieve a product","tags":["Product"]},"put":{"description":"Update an existing product. Returns a product object if the update is succeded.","operationId":"UpdateProduct","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Product"}}},"description":"Product object that you would like to update.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Product"}}},"description":"Product updated successfully.","headers":{"Retry-After":{"description":"How many seconds you have to wait before making new request.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Limit":{"description":"Request limit per minute.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Remaining":{"description":"The number of requests left for the time window.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Reset":{"description":"The timestamp at which the current rate limit window resets.","schema":{"format":"int32","type":"integer"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"500":{"$ref":"#/components/responses/ServerError"}},"summary":"Update a product","tags":["Product"]}},"/utils/convert-legacy-id/{id}":{"get":{"description":"Retrieves the API v3 ID.","operationId":"GetId","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Id"}}},"description":"Success response","headers":{"Retry-After":{"description":"How many seconds you have to wait before making new request.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Limit":{"description":"Request limit per minute.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Remaining":{"description":"The number of requests left for the time window.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Reset":{"description":"The timestamp at which the current rate limit window resets.","schema":{"format":"int32","type":"integer"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"500":{"$ref":"#/components/responses/ServerError"}},"summary":"Convert legacy ID to v3 ID.","tags":["Util"]}}},"components":{"responses":{"BadRequest":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientErrorResponse"}}},"description":"The request is malformed.","headers":{"Retry-After":{"description":"How many seconds you have to wait before making new request.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Limit":{"description":"Request limit per minute.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Remaining":{"description":"The number of requests left for the time window.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Reset":{"description":"The timestamp at which the current rate limit window resets.","schema":{"format":"int32","type":"integer"}}}},"Forbidden":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientErrorResponse"}}},"description":"Authenticated user doesn't have access to the resource.","headers":{"Retry-After":{"description":"How many seconds you have to wait before making new request.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Limit":{"description":"Request limit per minute.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Remaining":{"description":"The number of requests left for the time window.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Reset":{"description":"The timestamp at which the current rate limit window resets.","schema":{"format":"int32","type":"integer"}}}},"NotFound":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientErrorResponse"}}},"description":"Non-existent resource is requested.","headers":{"Retry-After":{"description":"How many seconds you have to wait before making new request.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Limit":{"description":"Request limit per minute.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Remaining":{"description":"The number of requests left for the time window.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Reset":{"description":"The timestamp at which the current rate limit window resets.","schema":{"format":"int32","type":"integer"}}}},"ServerError":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerErrorResponse"}}},"description":"Internal server error.","headers":{"Retry-After":{"description":"How many seconds you have to wait before making new request.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Limit":{"description":"Request limit per minute.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Remaining":{"description":"The number of requests left for the time window.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Reset":{"description":"The timestamp at which the current rate limit window resets.","schema":{"format":"int32","type":"integer"}}}},"Unauthorized":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientErrorResponse"}}},"description":"Authorization information is missing or invalid.","headers":{"Retry-After":{"description":"How many seconds you have to wait before making new request.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Limit":{"description":"Request limit per minute.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Remaining":{"description":"The number of requests left for the time window.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Reset":{"description":"The timestamp at which the current rate limit window resets.","schema":{"format":"int32","type":"integer"}}}},"UnprocessableEntity":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"description":"Validation errors occured.","headers":{"Retry-After":{"description":"How many seconds you have to wait before making new request.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Limit":{"description":"Request limit per minute.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Remaining":{"description":"The number of requests left for the time window.","schema":{"format":"int32","type":"integer"}},"X-RateLimit-Reset":{"description":"The timestamp at which the current rate limit window resets.","schema":{"format":"int32","type":"integer"}}}}},"schemas":{"Address":{"properties":{"address":{"type":"string"},"city":{"type":"string"},"country_code":{"$ref":"#/components/schemas/Country"},"post_code":{"type":"string"}},"required":["country_code","post_code","city","address"],"type":"object"},"BankAccount":{"properties":{"account_number":{"type":"string"},"account_number_iban":{"type":"string"},"currency":{"$ref":"#/components/schemas/Currency"},"id":{"readOnly":true,"type":"integer"},"name":{"type":"string"},"need_qr":{"default":"false","type":"boolean"},"swift":{"type":"string"}},"required":["name","account_number","currency"],"type":"object"},"BankAccountList":{"description":"A object with a data property that contains an array of up to limit bank accounts. Each entry in the array is a separate bank account object. If no more bank accounts are available, the resulting array will be empty.","properties":{"current_page":{"type":"integer"},"data":{"items":{"$ref":"#/components/schemas/BankAccount"},"type":"array"},"last_page":{"type":"integer"},"next_page_url":{"type":"string"},"per_page":{"type":"integer"},"prev_page_url":{"type":"string"},"total":{"type":"integer"}},"type":"object"},"ClientError":{"properties":{"message":{"type":"string"}},"type":"object"},"ClientErrorResponse":{"example":{"error":{"message":"Authorization information (Header: %s) is missing or invalid."}},"properties":{"error":{"$ref":"#/components/schemas/ClientError"}},"t