website·Indexed 30 days ago
https://docs.meridianosoft.com.arDocumentation for integrating management systems with MeridianoSoft via DLL or REST API. Includes guides on sending and retrieving data, required database tables for modules (such as clients, products, and brands), and technical specifications for the AppSyncHelper and Operations classes.
payment_collections_methods object in the REST API response provides details about the specific payment method used for a collection. It includes identifiers for the payment and the associated collection, the payment method code, and conditional fields based on the payment type (e.g., bank details for transfers or dates for checks).{
"payment_collection_method_id": 123, // Integer: Unique payment ID
"payment_collection_id": 456, // Integer: ID of the associated collection
"payment_method_code": "wire_transfer", // String: cash, wire_transfer, securities, others
"bank_id": 789, // Integer: Bank ID (for wire_transfer, securities)
"bank_account_id": 101, // Integer: Bank account ID (for wire_transfer)
"check_issuance_date": "2023-01-01", // String: ISO 8601 (for securities)
"check_expiration_date": "2023-02-01", // String: ISO 8601 (for securities)
"identification": "REF12345", // String: Check number or transfer reference
"wire_date": "2023-01-05", // String: ISO 8601 (for wire_transfer)
"description": "Payment note", // String: Used for 'others'
"amount": 1500.50, // Number: Payment amount
"observations": "Additional info" // String: Additional notes
}The new_clients object contains detailed information about a newly created customer. When processing this data, note the following conditional logic:
is_a_legal_person is true, the first_name and last_name fields will be empty strings; use legal_name instead. If is_a_legal_person is false, legal_name is automatically generated from the first and last names.identification field contains the CUIT (without hyphens) for legal persons and the DNI for physical persons.tax_condition_code field uses one of the following values: iva_responsable_inscripto, iva_responsable_monotributo, iva_sujeto_exento, or consumidor_final.address field is a combination of street_address and street_number.phone field is the complete number, composed of phone_country_code, phone_prefix, and phone_line_number.{
"new_client_id": 123,
"created_by_sales_agent_id": 456,
"first_name": "John",
"last_name": "Doe",
"legal_name": "John Doe",
"tax_condition_code": "iva_responsable_inscripto",
"is_a_legal_person": false,
"identification": "12345678",
"state_id": 1,
"state": "Buenos Aires",
"locality_id": 10,
"locality": "City",
"postal_code": "1000",
"street_address": "Main St",
"street_number": "123",
"address": "Main St 123",
"phone_country_code": "54",
"phone_prefix": "11",
"phone_line_number": "12345678",
"phone": "+54 11 12345678",
"first_opening_time": "08:00",
"first_closing_time": "12:00",
"second_opening_time": "14:00",
"second_closing_time": "18:00",
"email": "client@example.com",
"discount": 10.5,
"sales_agent_id": 456,
"price_list_id": 789,
"payment_term_id": 101,
"zone_id": 202,
"observations": "Note here",
"created_at": "2023-10-27T10:00:00Z"
}Because the DLL is developed in .NET, you must use regasm instead of regsvr32.
regasm.exe directory based on the system architecture:C:\Windows\Microsoft.NET\Framework\v4.0.30319C:\Windows\Microsoft.NET\Framework64\v4.0.30319/codebase flag.RegAsm.exe /codebase "C:/path/to/MeridianoSoftApp.dll"orders_items array contains details about individual items within an order. Note that the observations field is disabled by default in the App.{
"order_item_id": 123, // Integer: Unique ID of the order item
"order_id": 456, // Integer: Unique ID of the parent order
"product_id": 789, // Integer: Unique ID of the associated product
"quantity": 2, // Number: Selected quantity
"discount": 10.0, // Number: Discount percentage
"price_list_id": 10, // Integer: Unique ID of the applied price list
"price_multiplier": 1.0, // Number: Price multiplier
"unit_price_with_iva": 116.0, // Number: Unit price including VAT
"unit_price_without_iva": 100.0, // Number: Unit price excluding VAT
"final_price_with_iva": 232.0, // Number: Final price including VAT
"final_price_without_iva": 200.0, // Number: Final price excluding VAT
"observations": "Example note" // String: Additional observations
}https://api.meridianosoft.com.ar/api/v1. The API returns responses in JSON format, including a success field to indicate if the request was successful.GET https://api.meridianosoft.com.ar/api/v1/...AppRecordsUpdater.bas and AppOperationsRetriever.bas.new_clients, orders, orders_items, payment_collections, payment_collections_debts, and payment_collections_methods.{
"new_clients": [],
"orders": [],
"orders_items": [],
"payment_collections": [],
"payment_collections_debts": [],
"payment_collections_methods": []
}- Orders Module: clients, payment_terms, prices, prices_lists, products, brands (opt), categories (opt), groups (opt), sub_groups (opt), unit_types, sales_agents
- Collections Module: clients, clients_debts, banks (opt), banks_accounts (opt), collections_agents
- New Client Module: clients, price_lists, zones (opt), localities (opt), states (opt), sales_agentsTo use the provided DLLs (which are implemented in VB.NET for Visual Basic compatibility), .NET Framework 4.5.2 or a higher version must be installed on every machine where the DLL is deployed.
Supported Operating Systems:
Note: Windows 10 and newer versions come with a compatible version of .NET Framework pre-installed. The product installer will automatically check for a compatible version and offer to download it if not found.
To retrieve new operations (defined as new clients, orders, or payment collections generated in the mobile app or website) that have occurred since the last query, follow this workflow:
GET request to the /combined_updates endpoint with your authentication token in the header.POST request to mark the operations as processed.GET https://api.meridianosoft.com.ar/api/v1/combined_updatesOperations represent new clients, orders, or payment collections generated externally. To process them:
GetUpdates(token) to retrieve the operations object.HasOperations to verify if there is data to process.newClientsCount and GetNewClientByIndex).MarkAsProcessed(token, operations) to update the status on the server and avoid duplicate processing.Dim AppSyncHelper As New MeridianoSoftApp.AppSyncHelper
Dim operations As New MeridianoSoftApp.operations
Dim I As Long
Dim newClient As New MeridianoSoftApp.newClient
Dim token As String
token = "su-token-privado"
Public Sub RetrieveAppOperations()
On Error GoTo ErrorHandler
' Retrieve new operations
Set operations = AppSyncHelper.GetUpdates(token)
' Check if there are operations to process
If operations.HasOperations = False Then
MsgBox "No existen nuevas operaciones.", vbExclamation
Exit Sub
End If
' Iterate through new clients
For I = 0 To operations.newClientsCount - 1
Set newClient = operations.GetNewClientByIndex(I)
' Insert into your database here
MsgBox "Nuevo cliente: " & newClient.legalName
Next
' Note: Repeat iteration for orders and payment collections
' Mark operations as "Processed" on the server
Call AppSyncHelper.MarkAsProcessed(token, operations)
Exit Sub
ErrorHandler:
MsgBox "Ha ocurrido un error: " & Err.Description, vbExclamation
End Sub