### Util API Source: https://app.swaggerhub.com/apis/Billingo/Billingo/3.0.14 Utility endpoints for checking tax numbers, converting IDs, and getting server time. ```APIDOC ## GET /utils/check-tax-number/{tax_number} ### Description Check tax number. ### Method GET ### Endpoint /utils/check-tax-number/{tax_number} ``` ```APIDOC ## GET /utils/convert-legacy-id/{id} ### Description Convert legacy ID to v3 ID. ### Method GET ### Endpoint /utils/convert-legacy-id/{id} ``` ```APIDOC ## GET /utils/time ### Description Get the server time. ### Method GET ### Endpoint /utils/time ``` -------------------------------- ### Products API Source: https://app.swaggerhub.com/apis/Billingo/Billingo/3.0.14 Endpoints for managing products, including creation, retrieval, updates, and deletion. ```APIDOC ## GET /products ### Description Retrieves a list of products. ### Method GET ### Endpoint /products ### Parameters #### Query Parameters - **sort** (string) - Optional - The field to sort by. - **order** (string) - Optional - The order of sorting (asc or desc). - **page** (integer) - Optional - The page number for pagination. - **limit** (integer) - Optional - The number of items per page. ### Response #### Success Response (200) - **data** (array) - List of products. - **pagination** (object) - Pagination details. #### Response Example { "data": [ { "id": 1, "name": "Product X", "price": 50, "vat_rate_name": "27%" } ], "pagination": { "total": 15, "per_page": 10, "current_page": 1, "last_page": 2, "next_page_url": "/products?page=2", "prev_page_url": null } } ``` ```APIDOC ## POST /products ### Description Creates a new product. ### Method POST ### Endpoint /products ### Request Body - **product** (object) - Required - The product data. - **name** (string) - Required - The name of the product. - **price** (number) - Required - The price of the product. - **vat_rate_name** (string) - Required - The VAT rate name. - **unit** (string) - Optional - The unit of measurement. ### Request Example { "product": { "name": "New Gadget", "price": 75, "vat_rate_name": "27%", "unit": "piece" } } ### Response #### Success Response (200) - **id** (integer) - The ID of the created product. - **name** (string) - The name of the product. #### Response Example { "id": 26, "name": "New Gadget" } ``` ```APIDOC ## GET /products/{id} ### Description Retrieves a specific product by its ID. ### Method GET ### Endpoint /products/{id} ### Parameters #### Path Parameters - **id** (integer) - Required - The ID of the product. ### Response #### Success Response (200) - **id** (integer) - The ID of the product. - **name** (string) - The name of the product. - **price** (number) - The price of the product. - **vat_rate_name** (string) - The VAT rate name. - **unit** (string) - The unit of measurement. #### Response Example { "id": 1, "name": "Product X", "price": 50, "vat_rate_name": "27%", "unit": "piece" } ``` ```APIDOC ## PUT /products/{id} ### Description Updates an existing product. ### Method PUT ### Endpoint /products/{id} ### Parameters #### Path Parameters - **id** (integer) - Required - The ID of the product to update. ### Request Body - **product** (object) - Required - The updated product data. - **name** (string) - Optional - The name of the product. - **price** (number) - Optional - The price of the product. - **vat_rate_name** (string) - Optional - The VAT rate name. - **unit** (string) - Optional - The unit of measurement. ### Request Example { "product": { "price": 55 } } ### Response #### Success Response (200) - **id** (integer) - The ID of the updated product. - **name** (string) - The name of the product. #### Response Example { "id": 1, "name": "Product X" } ``` ```APIDOC ## DELETE /products/{id} ### Description Deletes a product. ### Method DELETE ### Endpoint /products/{id} ### Parameters #### Path Parameters - **id** (integer) - Required - The ID of the product to delete. ### Response #### Success Response (200) - **message** (string) - Confirmation message. #### Response Example { "message": "Product deleted successfully." } ``` -------------------------------- ### Product API Source: https://app.swaggerhub.com/apis/Billingo/Billingo/3.0.14 Endpoints for managing products, which are items included in documents. ```APIDOC ## GET /products ### Description List all products. ### Method GET ### Endpoint /products ``` ```APIDOC ## POST /products ### Description Create a product. ### Method POST ### Endpoint /products ``` ```APIDOC ## GET /products/{id} ### Description Retrieve a product. ### Method GET ### Endpoint /products/{id} ``` ```APIDOC ## PUT /products/{id} ### Description Update a product. ### Method PUT ### Endpoint /products/{id} ``` ```APIDOC ## DELETE /products/{id} ### Description Delete a product. ### Method DELETE ### Endpoint /products/{id} ``` -------------------------------- ### Currency API Source: https://app.swaggerhub.com/apis/Billingo/Billingo/3.0.14 Endpoint for retrieving currency exchange rates. ```APIDOC ## GET /currencies ### Description Get currencies exchange rate. ### Method GET ### Endpoint /currencies ``` -------------------------------- ### Schemas Source: https://app.swaggerhub.com/apis/Billingo/Billingo/3.0.14 Available schemas for request and response bodies. ```APIDOC ### Schemas ClientErrorResponse ServerErrorResponse SubscriptionErrorResponse TooManyRequestsResponse ValidationErrorResponse ClientError ServerError ValidationError BankAccount BankAccountList Address Country Currency ConversationRate CorrectionType Discount DiscountType Document DocumentAncestor DocumentBankAccount DocumentCancellation DocumentForm DocumentFormat DocumentInsert DocumentInsertType DocumentItem DocumentItemData DocumentLanguage DocumentList DocumentNotificationStatus DocumentOrganization DocumentPartner DocumentProductData DocumentPublicUrl DocumentSettings DocumentSummary DocumentType DocumentVatRateSummary Entitlement InvoiceSettings ModificationDocumentInsert OnlinePayment OnlineSzamlaStatus OnlineSzamlaStatusEnum OnlineSzamlaStatusMessage PaymentHistory PaymentMethod PaymentStatus ReceiptInsert ReceiptItemData ReceiptProductData Round SendDocument UnitPriceType Vat DocumentBlock DocumentBlockList DocumentBlockType CreateDocumentExport DocumentExportFilterExtra DocumentExportId DocumentExportOtherOptions DocumentExportQueryType DocumentExportSortBy DocumentExportStatus DocumentExportStatusState DocumentExportType LedgerNumberInformation Feature OrganizationData Subscription Partner PartnerCustomBillingSettings PartnerList PartnerTaxType Product ProductList Category DateType PaymentStatusSpending Source Spending SpendingList SpendingListItem SpendingPartner SpendingPaymentMethod SpendingSave CheckTaxNumberMessage Id ServerTime TaxNumber ``` -------------------------------- ### DocumentBlock API Source: https://app.swaggerhub.com/apis/Billingo/Billingo/3.0.14 Endpoints for managing document blocks, which represent invoice pads. ```APIDOC ## GET /document-blocks ### Description List all document blocks. ### Method GET ### Endpoint /document-blocks ``` -------------------------------- ### Utilities API Source: https://app.swaggerhub.com/apis/Billingo/Billingo/3.0.14 Utility endpoints for various checks and information retrieval. ```APIDOC ## GET /utils/check-tax-number/{tax_number} ### Description Checks the validity of a tax number. ### Method GET ### Endpoint /utils/check-tax-number/{tax_number} ### Parameters #### Path Parameters - **tax_number** (string) - Required - The tax number to check. ### Response #### Success Response (200) - **valid** (boolean) - Indicates if the tax number is valid. - **message** (string) - A message providing details about the validation. #### Response Example { "valid": true, "message": "Tax number is valid." } ``` ```APIDOC ## GET /utils/convert-legacy-id/{id} ### Description Converts a legacy ID to a new format. ### Method GET ### Endpoint /utils/convert-legacy-id/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The legacy ID to convert. ### Response #### Success Response (200) - **new_id** (string) - The converted new ID. #### Response Example { "new_id": "new-format-id-123" } ``` ```APIDOC ## GET /utils/time ### Description Retrieves the current server time. ### Method GET ### Endpoint /utils/time ### Response #### Success Response (200) - **server_time** (string) - The current server time in ISO 8601 format. #### Response Example { "server_time": "2023-11-30T14:30:00+00:00" } ``` -------------------------------- ### Partner API Source: https://app.swaggerhub.com/apis/Billingo/Billingo/3.0.14 Endpoints for managing partners, representing clients. ```APIDOC ## GET /partners ### Description List all partners. ### Method GET ### Endpoint /partners ``` ```APIDOC ## POST /partners ### Description Create a partner. ### Method POST ### Endpoint /partners ``` ```APIDOC ## GET /partners/{id} ### Description Retrieve a partner. ### Method GET ### Endpoint /partners/{id} ``` ```APIDOC ## PUT /partners/{id} ### Description Update a partner. ### Method PUT ### Endpoint /partners/{id} ``` ```APIDOC ## DELETE /partners/{id} ### Description Delete a partner. ### Method DELETE ### Endpoint /partners/{id} ``` -------------------------------- ### Currencies API Source: https://app.swaggerhub.com/apis/Billingo/Billingo/3.0.14 Endpoints for retrieving currency information. ```APIDOC ## GET /currencies ### Description Retrieves a list of available currencies. ### Method GET ### Endpoint /currencies ### Response #### Success Response (200) - **currencies** (array) - List of currency codes and names. #### Response Example { "currencies": [ { "code": "HUF", "name": "Hungarian Forint" }, { "code": "EUR", "name": "Euro" } ] } ``` -------------------------------- ### Spending API Source: https://app.swaggerhub.com/apis/Billingo/Billingo/3.0.14 Endpoints for managing spending records. ```APIDOC ## GET /spendings ### Description Lists all spending. ### Method GET ### Endpoint /spendings ``` ```APIDOC ## POST /spendings ### Description Creates a new spending. ### Method POST ### Endpoint /spendings ``` ```APIDOC ## GET /spendings/{id} ### Description Retrieves one specific spending. ### Method GET ### Endpoint /spendings/{id} ``` ```APIDOC ## PUT /spendings/{id} ### Description Updates a spending item. ### Method PUT ### Endpoint /spendings/{id} ``` ```APIDOC ## DELETE /spendings/{id} ### Description Deletes a spending. ### Method DELETE ### Endpoint /spendings/{id} ``` -------------------------------- ### Documents API Source: https://app.swaggerhub.com/apis/Billingo/Billingo/3.0.14 Endpoints for managing billing documents, including creation, retrieval, updates, and specific actions like archiving, canceling, and downloading. ```APIDOC ## GET /documents ### Description Retrieves a list of documents. ### Method GET ### Endpoint /documents ### Parameters #### Query Parameters - **vendor_id** (integer) - Optional - The ID of the vendor. - **partner_id** (integer) - Optional - The ID of the partner. - **product_id** (integer) - Optional - The ID of the product. - **status** (string) - Optional - The status of the document. - **type** (string) - Optional - The type of the document. - **created_from** (string) - Optional - The start date for creation. - **created_to** (string) - Optional - The end date for creation. - **due_date_from** (string) - Optional - The start date for due date. - **due_date_to** (string) - Optional - The end date for due date. - **sort** (string) - Optional - The field to sort by. - **order** (string) - Optional - The order of sorting (asc or desc). - **page** (integer) - Optional - The page number for pagination. - **limit** (integer) - Optional - The number of items per page. ### Response #### Success Response (200) - **data** (array) - List of documents. - **pagination** (object) - Pagination details. #### Response Example { "data": [ { "id": 1, "document_number": "INV-2023-001", "type": "invoice", "status": "paid", "due_date": "2023-12-31", "issue_date": "2023-11-30", "created_at": "2023-11-30T10:00:00+00:00", "updated_at": "2023-12-01T10:00:00+00:00" } ], "pagination": { "total": 10, "per_page": 10, "current_page": 1, "last_page": 1, "next_page_url": null, "prev_page_url": null } } ``` ```APIDOC ## POST /documents ### Description Creates a new document. ### Method POST ### Endpoint /documents ### Request Body - **document** (object) - Required - The document data. - **vendor_id** (integer) - Required - The ID of the vendor. - **partner_id** (integer) - Required - The ID of the partner. - **document_type** (string) - Required - The type of the document (e.g., 'invoice', 'proforma'). - **issue_date** (string) - Required - The issue date of the document. - **due_date** (string) - Required - The due date of the document. - **items** (array) - Required - The items included in the document. - **name** (string) - Required - The name of the item. - **quantity** (number) - Required - The quantity of the item. - **unit_price** (number) - Required - The unit price of the item. - **vat_rate_name** (string) - Required - The VAT rate name. - **payment_method** (string) - Optional - The payment method. - **currency** (string) - Optional - The currency of the document. ### Request Example { "document": { "vendor_id": 1, "partner_id": 2, "document_type": "invoice", "issue_date": "2023-11-30", "due_date": "2023-12-31", "items": [ { "name": "Product A", "quantity": 2, "unit_price": 100, "vat_rate_name": "27%" } ], "payment_method": "bank_transfer", "currency": "HUF" } } ### Response #### Success Response (200) - **id** (integer) - The ID of the created document. - **document_number** (string) - The document number. #### Response Example { "id": 123, "document_number": "INV-2023-001" } ``` ```APIDOC ## POST /documents/receipt ### Description Creates a new receipt. ### Method POST ### Endpoint /documents/receipt ### Request Body - **receipt** (object) - Required - The receipt data. - **vendor_id** (integer) - Required - The ID of the vendor. - **partner_id** (integer) - Required - The ID of the partner. - **issue_date** (string) - Required - The issue date of the receipt. - **items** (array) - Required - The items included in the receipt. - **name** (string) - Required - The name of the item. - **quantity** (number) - Required - The quantity of the item. - **unit_price** (number) - Required - The unit price of the item. - **vat_rate_name** (string) - Required - The VAT rate name. - **payment_method** (string) - Optional - The payment method. - **currency** (string) - Optional - The currency of the receipt. ### Request Example { "receipt": { "vendor_id": 1, "partner_id": 2, "issue_date": "2023-11-30", "items": [ { "name": "Product B", "quantity": 1, "unit_price": 50, "vat_rate_name": "27%" } ], "payment_method": "cash", "currency": "HUF" } } ### Response #### Success Response (200) - **id** (integer) - The ID of the created receipt. - **document_number** (string) - The receipt number. #### Response Example { "id": 456, "document_number": "RCP-2023-001" } ``` ```APIDOC ## PUT /documents/receipt/{id} ### Description Updates an existing receipt. ### Method PUT ### Endpoint /documents/receipt/{id} ### Parameters #### Path Parameters - **id** (integer) - Required - The ID of the receipt to update. ### Request Body - **receipt** (object) - Required - The updated receipt data. - **issue_date** (string) - Optional - The issue date of the receipt. - **items** (array) - Optional - The items included in the receipt. - **name** (string) - Required - The name of the item. - **quantity** (number) - Required - The quantity of the item. - **unit_price** (number) - Required - The unit price of the item. - **vat_rate_name** (string) - Required - The VAT rate name. - **payment_method** (string) - Optional - The payment method. - **currency** (string) - Optional - The currency of the receipt. ### Request Example { "receipt": { "issue_date": "2023-12-01", "items": [ { "name": "Product B Updated", "quantity": 1, "unit_price": 55, "vat_rate_name": "27%" } ] } } ### Response #### Success Response (200) - **id** (integer) - The ID of the updated receipt. - **document_number** (string) - The receipt number. #### Response Example { "id": 456, "document_number": "RCP-2023-001" } ``` ```APIDOC ## GET /documents/vendor/{vendor_id} ### Description Retrieves documents for a specific vendor. ### Method GET ### Endpoint /documents/vendor/{vendor_id} ### Parameters #### Path Parameters - **vendor_id** (integer) - Required - The ID of the vendor. #### Query Parameters - **type** (string) - Optional - The type of the document. - **status** (string) - Optional - The status of the document. - **created_from** (string) - Optional - The start date for creation. - **created_to** (string) - Optional - The end date for creation. - **sort** (string) - Optional - The field to sort by. - **order** (string) - Optional - The order of sorting (asc or desc). - **page** (integer) - Optional - The page number for pagination. - **limit** (integer) - Optional - The number of items per page. ### Response #### Success Response (200) - **data** (array) - List of documents for the vendor. - **pagination** (object) - Pagination details. #### Response Example { "data": [ { "id": 1, "document_number": "INV-2023-001", "type": "invoice", "status": "paid", "due_date": "2023-12-31", "issue_date": "2023-11-30", "created_at": "2023-11-30T10:00:00+00:00", "updated_at": "2023-12-01T10:00:00+00:00" } ], "pagination": { "total": 5, "per_page": 10, "current_page": 1, "last_page": 1, "next_page_url": null, "prev_page_url": null } } ``` ```APIDOC ## GET /documents/{id} ### Description Retrieves a specific document by its ID. ### Method GET ### Endpoint /documents/{id} ### Parameters #### Path Parameters - **id** (integer) - Required - The ID of the document. ### Response #### Success Response (200) - **id** (integer) - The ID of the document. - **document_number** (string) - The document number. - **type** (string) - The type of the document. - **status** (string) - The status of the document. - **issue_date** (string) - The issue date. - **due_date** (string) - The due date. - **total_amount** (number) - The total amount. - **currency** (string) - The currency. - **items** (array) - The items in the document. - **created_at** (string) - The creation timestamp. - **updated_at** (string) - The update timestamp. #### Response Example { "id": 123, "document_number": "INV-2023-001", "type": "invoice", "status": "paid", "issue_date": "2023-11-30", "due_date": "2023-12-31", "total_amount": 127, "currency": "HUF", "items": [ { "name": "Product A", "quantity": 2, "unit_price": 100, "vat_rate_name": "27%", "line_total": 200 } ], "created_at": "2023-11-30T10:00:00+00:00", "updated_at": "2023-12-01T10:00:00+00:00" } ``` ```APIDOC ## PUT /documents/{id} ### Description Updates an existing document. ### Method PUT ### Endpoint /documents/{id} ### Parameters #### Path Parameters - **id** (integer) - Required - The ID of the document to update. ### Request Body - **document** (object) - Required - The updated document data. - **issue_date** (string) - Optional - The issue date of the document. - **due_date** (string) - Optional - The due date of the document. - **items** (array) - Optional - The items included in the document. - **name** (string) - Required - The name of the item. - **quantity** (number) - Required - The quantity of the item. - **unit_price** (number) - Required - The unit price of the item. - **vat_rate_name** (string) - Required - The VAT rate name. - **payment_method** (string) - Optional - The payment method. - **currency** (string) - Optional - The currency of the document. ### Request Example { "document": { "due_date": "2024-01-15", "items": [ { "name": "Product A Updated", "quantity": 2, "unit_price": 110, "vat_rate_name": "27%" } ] } } ### Response #### Success Response (200) - **id** (integer) - The ID of the updated document. - **document_number** (string) - The document number. #### Response Example { "id": 123, "document_number": "INV-2023-001" } ``` ```APIDOC ## DELETE /documents/{id} ### Description Deletes a document. ### Method DELETE ### Endpoint /documents/{id} ### Parameters #### Path Parameters - **id** (integer) - Required - The ID of the document to delete. ### Response #### Success Response (200) - **message** (string) - Confirmation message. #### Response Example { "message": "Document deleted successfully." } ``` ```APIDOC ## PUT /documents/{id}/archive ### Description Archives a document. ### Method PUT ### Endpoint /documents/{id}/archive ### Parameters #### Path Parameters - **id** (integer) - Required - The ID of the document to archive. ### Response #### Success Response (200) - **message** (string) - Confirmation message. #### Response Example { "message": "Document archived successfully." } ``` ```APIDOC ## POST /documents/{id}/cancel ### Description Cancels a document. ### Method POST ### Endpoint /documents/{id}/cancel ### Parameters #### Path Parameters - **id** (integer) - Required - The ID of the document to cancel. ### Response #### Success Response (200) - **message** (string) - Confirmation message. #### Response Example { "message": "Document canceled successfully." } ``` ```APIDOC ## POST /documents/{id}/copy ### Description Creates a copy of a document. ### Method POST ### Endpoint /documents/{id}/copy ### Parameters #### Path Parameters - **id** (integer) - Required - The ID of the document to copy. ### Response #### Success Response (200) - **id** (integer) - The ID of the newly created copy. - **document_number** (string) - The document number of the copy. #### Response Example { "id": 789, "document_number": "INV-2023-002-COPY" } ``` ```APIDOC ## POST /documents/{id}/create-from-proforma ### Description Creates a new document from a proforma invoice. ### Method POST ### Endpoint /documents/{id}/create-from-proforma ### Parameters #### Path Parameters - **id** (integer) - Required - The ID of the proforma invoice. ### Response #### Success Response (200) - **id** (integer) - The ID of the newly created document. - **document_number** (string) - The document number. #### Response Example { "id": 101, "document_number": "INV-2023-003" } ``` ```APIDOC ## POST /documents/{id}/create-modification-document ### Description Creates a modification document for an existing document. ### Method POST ### Endpoint /documents/{id}/create-modification-document ### Parameters #### Path Parameters - **id** (integer) - Required - The ID of the original document. ### Request Body - **modification_document** (object) - Required - The modification document data. - **modification_type** (string) - Required - The type of modification ('credit_note', 'correction_invoice'). - **issue_date** (string) - Optional - The issue date of the modification document. - **due_date** (string) - Optional - The due date of the modification document. - **items** (array) - Optional - The items to modify. ### Request Example { "modification_document": { "modification_type": "credit_note", "issue_date": "2023-12-05" } } ### Response #### Success Response (200) - **id** (integer) - The ID of the newly created modification document. - **document_number** (string) - The document number. #### Response Example { "id": 102, "document_number": "CN-2023-001" } ``` ```APIDOC ## GET /documents/{id}/download ### Description Downloads a document. ### Method GET ### Endpoint /documents/{id}/download ### Parameters #### Path Parameters - **id** (integer) - Required - The ID of the document to download. #### Query Parameters - **format** (string) - Optional - The desired format (e.g., 'pdf', 'xml'). Defaults to 'pdf'. ### Response #### Success Response (200) - The response will be the file content in the specified format. #### Response Example (Binary content of the PDF or XML file) ``` ```APIDOC ## GET /documents/{id}/online-szamla ### Description Retrieves the online számla status for a document. ### Method GET ### Endpoint /documents/{id}/online-szamla ### Parameters #### Path Parameters - **id** (integer) - Required - The ID of the document. ### Response #### Success Response (200) - **status** (string) - The online számla status. - **message** (string) - A message related to the status. #### Response Example { "status": "sent", "message": "Document successfully sent to online számla." } ``` ```APIDOC ## GET /documents/{id}/payments ### Description Retrieves the payment history for a document. ### Method GET ### Endpoint /documents/{id}/payments ### Parameters #### Path Parameters - **id** (integer) - Required - The ID of the document. ### Response #### Success Response (200) - **payments** (array) - List of payments. #### Response Example { "payments": [ { "id": 1, "amount": 127, "payment_date": "2023-12-01", "payment_method": "bank_transfer" } ] } ``` ```APIDOC ## PUT /documents/{id}/payments ### Description Adds or updates payments for a document. ### Method PUT ### Endpoint /documents/{id}/payments ### Parameters #### Path Parameters - **id** (integer) - Required - The ID of the document. ### Request Body - **payments** (array) - Required - The list of payments. - **amount** (number) - Required - The payment amount. - **payment_date** (string) - Required - The date of the payment. - **payment_method** (string) - Optional - The payment method. ### Request Example { "payments": [ { "amount": 127, "payment_date": "2023-12-01", "payment_method": "bank_transfer" } ] } ### Response #### Success Response (200) - **message** (string) - Confirmation message. #### Response Example { "message": "Payments updated successfully." } ``` ```APIDOC ## DELETE /documents/{id}/payments ### Description Deletes all payments for a document. ### Method DELETE ### Endpoint /documents/{id}/payments ### Parameters #### Path Parameters - **id** (integer) - Required - The ID of the document. ### Response #### Success Response (200) - **message** (string) - Confirmation message. #### Response Example { "message": "Payments deleted successfully." } ``` ```APIDOC ## GET /documents/{id}/print/pos ### Description Prints a document in POS format. ### Method GET ### Endpoint /documents/{id}/print/pos ### Parameters #### Path Parameters - **id** (integer) - Required - The ID of the document. ### Response #### Success Response (200) - The response will be the document content in POS print format. #### Response Example (Text content formatted for POS printing) ``` ```APIDOC ## GET /documents/{id}/public-url ### Description Retrieves the public URL for a document. ### Method GET ### Endpoint /documents/{id}/public-url ### Parameters #### Path Parameters - **id** (integer) - Required - The ID of the document. ### Response #### Success Response (200) - **public_url** (string) - The public URL of the document. #### Response Example { "public_url": "https://billingo.hu/view/document/abcdef12345" } ``` ```APIDOC ## POST /documents/{id}/send ### Description Sends a document to the partner. ### Method POST ### Endpoint /documents/{id}/send ### Parameters #### Path Parameters - **id** (integer) - Required - The ID of the document to send. ### Request Body - **send_options** (object) - Optional - Options for sending the document. - **send_email** (boolean) - Optional - Whether to send an email. - **email_subject** (string) - Optional - The subject of the email. - **email_body** (string) - Optional - The body of the email. ### Request Example { "send_options": { "send_email": true, "email_subject": "Your Invoice", "email_body": "Please find your invoice attached." } } ### Response #### Success Response (200) - **message** (string) - Confirmation message. #### Response Example { "message": "Document sent successfully." } ``` -------------------------------- ### Organization API Source: https://app.swaggerhub.com/apis/Billingo/Billingo/3.0.14 Endpoint for retrieving organization data. ```APIDOC ## GET /organization ### Description Retrieve organization data. ### Method GET ### Endpoint /organization ``` -------------------------------- ### Organization API Source: https://app.swaggerhub.com/apis/Billingo/Billingo/3.0.14 Endpoints for retrieving organization-specific information. ```APIDOC ## GET /organization ### Description Retrieves information about the organization. ### Method GET ### Endpoint /organization ### Response #### Success Response (200) - **name** (string) - The name of the organization. - **tax_number** (string) - The organization's tax number. - **address** (object) - The organization's address. #### Response Example { "name": "My Company Ltd.", "tax_number": "11223344-5-66", "address": { "street": "1 Business Rd", "city": "Metropolis", "postal_code": "54321", "country_code": "US" } } ``` -------------------------------- ### Partners API Source: https://app.swaggerhub.com/apis/Billingo/Billingo/3.0.14 Endpoints for managing partners (customers and suppliers), including creation, retrieval, updates, and deletion. ```APIDOC ## GET /partners ### Description Retrieves a list of partners. ### Method GET ### Endpoint /partners ### Parameters #### Query Parameters - **sort** (string) - Optional - The field to sort by. - **order** (string) - Optional - The order of sorting (asc or desc). - **page** (integer) - Optional - The page number for pagination. - **limit** (integer) - Optional - The number of items per page. ### Response #### Success Response (200) - **data** (array) - List of partners. - **pagination** (object) - Pagination details. #### Response Example { "data": [ { "id": 1, "name": "Customer A", "email": "customer.a@example.com", "tax_number": "12345678-1-12" } ], "pagination": { "total": 20, "per_page": 10, "current_page": 1, "last_page": 2, "next_page_url": "/partners?page=2", "prev_page_url": null } } ``` ```APIDOC ## POST /partners ### Description Creates a new partner. ### Method POST ### Endpoint /partners ### Request Body - **partner** (object) - Required - The partner data. - **name** (string) - Required - The name of the partner. - **email** (string) - Optional - The email address of the partner. - **tax_number** (string) - Optional - The tax number of the partner. - **address** (object) - Optional - The address of the partner. - **street** (string) - Required - Street name and number. - **city** (string) - Required - City. - **postal_code** (string) - Required - Postal code. - **country_code** (string) - Required - ISO 3166-1 alpha-2 country code. ### Request Example { "partner": { "name": "New Customer", "email": "new.customer@example.com", "tax_number": "98765432-1-12", "address": { "street": "123 Main St", "city": "Anytown", "postal_code": "12345", "country_code": "US" } } } ### Response #### Success Response (200) - **id** (integer) - The ID of the created partner. - **name** (string) - The name of the partner. #### Response Example { "id": 21, "name": "New Customer" } ``` ```APIDOC ## GET /partners/{id} ### Description Retrieves a specific partner by its ID. ### Method GET ### Endpoint /partners/{id} ### Parameters #### Path Parameters - **id** (integer) - Required - The ID of the partner. ### Response #### Success Response (200) - **id** (integer) - The ID of the partner. - **name** (string) - The name of the partner. - **email** (string) - The email address. - **tax_number** (string) - The tax number. - **address** (object) - The address of the partner. #### Response Example { "id": 1, "name": "Customer A", "email": "customer.a@example.com", "tax_number": "12345678-1-12", "address": { "street": "456 Oak Ave", "city": "Otherville", "postal_code": "67890", "country_code": "US" } } ``` ```APIDOC ## PUT /partners/{id} ### Description Updates an existing partner. ### Method PUT ### Endpoint /partners/{id} ### Parameters #### Path Parameters - **id** (integer) - Required - The ID of the partner to update. ### Request Body - **partner** (object) - Required - The updated partner data. - **name** (string) - Optional - The name of the partner. - **email** (string) - Optional - The email address of the partner. - **tax_number** (string) - Optional - The tax number of the partner. - **address** (object) - Optional - The address of the partner. ### Request Example { "partner": { "email": "customer.a.updated@example.com" } } ### Response #### Success Response (200) - **id** (integer) - The ID of the updated partner. - **name** (string) - The name of the partner. #### Response Example { "id": 1, "name": "Customer A" } ``` ```APIDOC ## DELETE /partners/{id} ### Description Deletes a partner. ### Method DELETE ### Endpoint /partners/{id} ### Parameters #### Path Parameters - **id** (integer) - Required - The ID of the partner to delete. ### Response #### Success Response (200) - **message** (string) - Confirmation message. #### Response Example { "message": "Partner deleted successfully." } ``` -------------------------------- ### Document Management API Source: https://app.swaggerhub.com/apis/Billingo/Billingo/3.0.14 Endpoints for managing documents, including listing, creating, retrieving, updating, deleting, and downloading invoices and receipts. ```APIDOC ## GET /documents ### Description List all documents. ### Method GET ### Endpoint /documents ``` ```APIDOC ## POST /documents ### Description Create a document. ### Method POST ### Endpoint /documents ``` ```APIDOC ## POST /documents/receipt ### Description Create a receipt. ### Method POST ### Endpoint /documents/receipt ``` ```APIDOC ## PUT /documents/receipt/{id} ### Description Converts a draft to a receipt. ### Method PUT ### Endpoint /documents/receipt/{id} ``` ```APIDOC ## GET /documents/vendor/{vendor_id} ### Description Retrieve a document by vendor id. ### Method GET ### Endpoint /documents/vendor/{vendor_id} ``` ```APIDOC ## GET /documents/{id} ### Description Retrieve a document. ### Method GET ### Endpoint /documents/{id} ``` ```APIDOC ## PUT /documents/{id} ### Description Converts a draft to an invoice. ### Method PUT ### Endpoint /documents/{id} ``` ```APIDOC ## DELETE /documents/{id} ### Description Delete a draft. ### Method DELETE ### Endpoint /documents/{id} ``` ```APIDOC ## PUT /documents/{id}/archive ### Description Archive a proforma document. ### Method PUT ### Endpoint /documents/{id}/archive ``` ```APIDOC ## POST /documents/{id}/cancel ### Description Cancel a document. ### Method POST ### Endpoint /documents/{id}/cancel ``` ```APIDOC ## POST /documents/{id}/copy ### Description Copy a document. ### Method POST ### Endpoint /documents/{id}/copy ``` ```APIDOC ## POST /documents/{id}/create-from-proforma ### Description Create a document from proforma. ### Method POST ### Endpoint /documents/{id}/create-from-proforma ``` ```APIDOC ## POST /documents/{id}/create-modification-document ### Description Create a modification document. ### Method POST ### Endpoint /documents/{id}/create-modification-document ``` ```APIDOC ## GET /documents/{id}/download ### Description Download a document in PDF format. ### Method GET ### Endpoint /documents/{id}/download ``` ```APIDOC ## GET /documents/{id}/online-szamla ### Description Retrieve a document Online Számla status. ### Method GET ### Endpoint /documents/{id}/online-szamla ``` ```APIDOC ## GET /documents/{id}/payments ### Description Retrieve a payment history. ### Method GET ### Endpoint /documents/{id}/payments ``` ```APIDOC ## PUT /documents/{id}/payments ### Description Update payment history. ### Method PUT ### Endpoint /documents/{id}/payments ``` ```APIDOC ## DELETE /documents/{id}/payments ### Description Delete all payment history on document. ### Method DELETE ### Endpoint /documents/{id}/payments ``` ```APIDOC ## GET /documents/{id}/print/pos ### Description Returns a printable POS PDF. ### Method GET ### Endpoint /documents/{id}/print/pos ``` ```APIDOC ## GET /documents/{id}/public-url ### Description Retrieve a document download public URL. ### Method GET ### Endpoint /documents/{id}/public-url ``` ```APIDOC ## POST /documents/{id}/send ### Description Send invoice to given email addresses. ### Method POST ### Endpoint /documents/{id}/send ``` -------------------------------- ### Document Blocks API Source: https://app.swaggerhub.com/apis/Billingo/Billingo/3.0.14 Endpoints for managing document blocks, which can be used to group items or provide additional information within documents. ```APIDOC ## GET /document-blocks ### Description Retrieves a list of document blocks. ### Method GET ### Endpoint /document-blocks ### Parameters #### Query Parameters - **type** (string) - Optional - Filter by document block type. - **sort** (string) - Optional - The field to sort by. - **order** (string) - Optional - The order of sorting (asc or desc). - **page** (integer) - Optional - The page number for pagination. - **limit** (integer) - Optional - The number of items per page. ### Response #### Success Response (200) - **data** (array) - List of document blocks. - **pagination** (object) - Pagination details. #### Response Example { "data": [ { "id": 1, "name": "Header Block", "type": "header", "content": "Company Information" } ], "pagination": { "total": 5, "per_page": 10, "current_page": 1, "last_page": 1, "next_page_url": null, "prev_page_url": null } } ```