NAiOS IconNAiOS Logo
Contacto
Volver al catálogo

Proabono

proabono

ProAbono is the smart subscription management software that automates your daily routine.

EcommerceWeb del proveedor
Acciones
67
Triggers
0
Autenticación
—
OAuth gestionado
No
Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

Acciones disponibles (67)

Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.

Anonymize CustomerPROABONO_ANONYMIZE_CUSTOMERAcción

Tool to anonymize a customer for GDPR compliance. Use when you need to permanently remove personal data from a customer record while maintaining the account structure. The customer must have no active subscriptions, all invoices must be settled, and the balance must be empty before anonymization.

Parámetros de entrada

  • reference_customerstringObligatorio

    The unique reference of the customer to anonymize. This is your application's customer reference identifier.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Bill CustomerPROABONO_BILL_CUSTOMERAcción

Tool to trigger billing for a customer. Use when you need to create invoices for pending charges for a specific customer.

Parámetros de entrada

  • ReferenceCustomerstringObligatorio

    The unique reference of the customer to bill. This identifier is used to trigger billing and create invoices for pending charges.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create CustomerPROABONO_CREATE_CUSTOMERAcción

Tool to create or declare a customer in ProAbono via the Backoffice API. Use when you need to register a new customer with billing and subscription management capabilities.

Parámetros de entrada

  • Namestring

    Display Name of your customer

  • EmailstringObligatorio

    Email of your customer

  • Languagestring

    Language of your customer. By Default, ProAbono will use the language of the segment

  • Metadataobject

    Custom key-value metadata for the customer (max 5 pairs, 50-char keys, 450-char values)

  • IdBusinessintegerObligatorio

    Id of your Business

  • ReferenceSegmentstring

    Reference of the segment in which the customer will be created. Required only if you have more than 1 segment

  • ReferenceCustomerstring

    Reference of your customer shared with your application and ProAbono. Use your own id/reference user

  • ReferenceAffiliationstring

    Reference of the affiliate

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create FeaturePROABONO_CREATE_FEATUREAcción

Tool to create a new feature in ProAbono via the Backoffice API. Features define capabilities or usage limits that can be attached to offers. Use when you need to define a new feature (OnOff, Limitation, or Consumption type) for your subscription plans.

Parámetros de entrada

  • Namestring

    The feature name displayed to users

  • Orderinteger

    Display position among other features (lower numbers appear first)

  • IsVisibleboolean

    Whether to show this feature in offers and hosted pages

  • IdBusinessintegerObligatorio

    Your Business identifier

  • TypeFeaturestringenum

    Feature type enumeration.

    OnOffLimitationConsumption
  • ReferenceFeaturestring

    Shared key between ProAbono and your system for identifying this feature

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete CustomerPROABONO_DELETE_CUSTOMERAcción

Tool to delete a customer from ProAbono by ID. Use when you need to remove a customer record from the system.

Parámetros de entrada

  • idintegerObligatorio

    ID of the customer to delete. This is the unique customer identifier in ProAbono.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete OfferPROABONO_DELETE_OFFERAcción

Tool to delete an offer from ProAbono by ID. Use when you need to permanently remove an offer from the system.

Parámetros de entrada

  • idintegerObligatorio

    The unique ID of the offer to delete

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete Pricing TablePROABONO_DELETE_PRICING_TABLEAcción

Tool to delete a pricing table from ProAbono by its ID. Use when you need to remove a pricing table from the system.

Parámetros de entrada

  • idintegerObligatorio

    The unique ID of the pricing table to delete.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete Pricing Table OfferPROABONO_DELETE_PRICING_TABLE_OFFERAcción

Tool to delete a pricing table offer via the ProAbono Backoffice API. Use when you need to remove an existing pricing table offer by its ID.

Parámetros de entrada

  • idintegerObligatorio

    The unique identifier of the pricing table offer to delete

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete Subscription DiscountPROABONO_DELETE_SUBSCRIPTION_DISCOUNTAcción

Tool to delete a subscription discount via the Backoffice API. Use when you need to remove a discount from a subscription after confirming its ID.

Parámetros de entrada

  • idintegerObligatorio

    The subscription discount ID to delete

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Enable WebhookPROABONO_ENABLE_WEBHOOKAcción

Tool to enable a webhook in ProAbono via the Notification API. Use when you need to activate a previously disabled webhook for receiving event notifications.

Parámetros de entrada

  • idintegerObligatorio

    The unique identifier of the webhook to enable. Must be a valid webhook ID from your ProAbono account.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Customer by IDPROABONO_GET_CUSTOMERAcción

Tool to retrieve a single customer by ID from ProAbono Backoffice API. Use when you need to fetch detailed information about a specific customer including their billing details, status, and related resource links.

Parámetros de entrada

  • idintegerObligatorio

    The unique identifier of the customer to retrieve

  • id_businessinteger

    The business identifier. Optional parameter to scope the request to a specific business

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Customer Billing AddressPROABONO_GET_CUSTOMER_BILLINGAcción

Tool to retrieve a customer's billing address via the Backoffice API. Use when you need to fetch billing information including company name, contact details, address lines, and tax information for a specific customer.

Parámetros de entrada

  • idintegerObligatorio

    The customer ID whose billing address to retrieve

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Customer Billing Address by ReferencePROABONO_GET_CUSTOMER_BILLING_ADDRESSAcción

Tool to retrieve the billing address for a customer by reference from ProAbono API. Use when you need to fetch billing address details including company, contact information, address lines, and tax information using the customer's reference identifier.

Parámetros de entrada

  • reference_customerstringObligatorio

    The unique reference of the customer to retrieve billing address for. This is the shared identifier between ProAbono and your application.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Customer by ReferencePROABONO_GET_CUSTOMER_BY_REFERENCEAcción

Tool to retrieve a customer by their reference identifier from ProAbono API. Use when you need to fetch customer details using the unique reference identifier from your own application rather than the ProAbono internal ID.

Parámetros de entrada

  • reference_customerstringObligatorio

    The unique reference identifier of the customer to retrieve, used within your own application

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Customer Payment SettingsPROABONO_GET_CUSTOMER_PAYMENT_SETTINGSAcción

Tool to retrieve customer payment settings via the Backoffice API. Use when you need to check a customer's payment configuration, billing schedule, or payment method type.

Parámetros de entrada

  • ReferenceCustomerstringObligatorio

    The unique reference identifier of the customer whose payment settings to retrieve (ReferenceCustomer property)

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get DiscountPROABONO_GET_DISCOUNTAcción

Tool to retrieve a discount by ID via the Backoffice API. Use when you need to fetch details of a specific discount including its amount, type, target fees, and state.

Parámetros de entrada

  • IdintegerObligatorio

    The discount ID to retrieve

  • IdBusinessintegerObligatorio

    Your business ID

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Feature by IDPROABONO_GET_FEATUREAcción

Tool to retrieve a feature by ID from ProAbono Backoffice API. Use when you need to fetch details about a specific feature.

Parámetros de entrada

  • idintegerObligatorio

    ID of the feature to retrieve

  • id_businessstring

    Optional business identifier filter

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Feature by ReferencePROABONO_GET_FEATURE_BY_REFERENCEAcción

Tool to retrieve a single feature by its reference from ProAbono API. Use when you need to fetch details about a specific feature using its unique reference identifier.

Parámetros de entrada

  • reference_featurestringObligatorio

    The reference of the feature to retrieve

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get InvoicePROABONO_GET_INVOICEAcción

Tool to retrieve a specific invoice or credit note by ID from ProAbono. Use when you need to fetch detailed information about an invoice.

Parámetros de entrada

  • idintegerObligatorio

    The unique identifier of the invoice or credit note to retrieve.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Offer by IDPROABONO_GET_OFFERAcción

Tool to retrieve a single offer by its ID from ProAbono Backoffice API. Use when you need to fetch detailed information about a specific offer.

Parámetros de entrada

  • idintegerObligatorio

    The unique identifier of the offer to retrieve

  • id_businessintegerObligatorio

    The business identifier. Required to scope the request to a specific business

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Subscription by Customer ReferencePROABONO_GET_SUBSCRIPTION_BY_CUSTOMERAcción

Tool to retrieve a subscription by customer reference from ProAbono. Use when you need to fetch subscription details for a specific customer using their reference key.

Parámetros de entrada

  • id_businessinteger

    The business identifier. Optional parameter to scope the request to a specific business

  • reference_customerstringObligatorio

    The unique reference of the customer to retrieve their subscription

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Subscription Creation QuotePROABONO_GET_SUBSCRIPTION_CREATION_QUOTEAcción

Tool to get a pricing quote for creating a new subscription without actually creating it. Use when you need to calculate the cost of a subscription before committing to its creation.

Parámetros de entrada

  • ReferenceOfferstringObligatorio

    The reference of the offer to quote for subscription creation

  • ReferenceCustomerstringObligatorio

    The unique reference of the customer for whom the subscription quote is being generated

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Usage RecordPROABONO_GET_USAGEAcción

Tool to retrieve a single usage record for a specific feature and customer combination from ProAbono. Use when you need to check current usage status, remaining quota, or feature availability for a customer. The response varies based on feature type: OnOff features return IsIncluded/IsEnabled, while Limitation and Consumption features return quantity information.

Parámetros de entrada

  • ReferenceFeaturestringObligatorio

    The reference of the feature to retrieve usage for. This is the shared key between ProAbono and your application.

  • ReferenceCustomerstringObligatorio

    The unique reference of the customer to retrieve usage for. This is the identifier from your application.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Usages for CustomerPROABONO_GET_USAGES_FOR_CUSTOMERAcción

Tool to retrieve usage data for customers from ProAbono. Use when you need to fetch feature usage information including OnOff, Limitation, and Consumption features. Parameters can be combined to filter results by customer reference, customer ID, or subscription ID.

Parámetros de entrada

  • IdCustomerinteger

    Retrieve usages exclusively from a specific customer by ID

  • IdSubscriptioninteger

    Retrieve usages exclusively from a specific subscription by ID

  • ReferenceCustomerstring

    Reference of the customer - retrieve usages exclusively from this customer

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Invalidate CustomerPROABONO_INVALIDATE_CUSTOMERAcción

Tool to invalidate a customer by their reference. Use when you need to revoke a customer's access to subscribed services while keeping the account record.

Parámetros de entrada

  • reference_customerstringObligatorio

    The unique reference of the customer to invalidate. This is your application's customer reference identifier.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Invalidate Customer by IDPROABONO_INVALIDATE_CUSTOMER_BY_IDAcción

Tool to invalidate a customer by their ProAbono internal ID. Use when you need to free up a customer reference for reuse. This operation replaces the customer's ReferenceCustomer with a new value and regenerates all encrypted portal links.

Parámetros de entrada

  • id_customerintegerObligatorio

    The ProAbono internal ID of the customer to invalidate. This operation replaces the customer's reference identifier with a new value, allowing the original reference to be reused for a different customer.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List Balance LinesPROABONO_LIST_BALANCE_LINESAcción

Tool to list all balance lines from ProAbono. Use when you need to retrieve one-time charges or credits associated with a customer or subscription. Either ReferenceCustomer or IdSubscription parameter is required.

Parámetros de entrada

  • nextBillingboolean

    Flag to retrieve the outstanding balances of the upcoming billing. Set to true to get only balance lines that will be included in the next billing.

  • IdSubscriptioninteger

    The ID of the subscription to retrieve balance lines for. Either ReferenceCustomer or IdSubscription must be provided.

  • ReferenceCustomerstring

    The reference of the customer to retrieve balance lines for. Either ReferenceCustomer or IdSubscription must be provided.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List BusinessesPROABONO_LIST_BUSINESSESAcción

Tool to list all businesses from ProAbono via the Backoffice API. Use when you need to retrieve business information with optional filtering by state or update date.

Parámetros de entrada

  • StateLifestring

    Filter businesses by lifecycle state. Common values include 'Ok' for active businesses.

  • DateUpdateMinstring

    Filter businesses updated after this date. Must be in ISO 8601 format (e.g., '2023-04-27T06:54:00').

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List Business LocalizationPROABONO_LIST_BUSINESS_LOCALIZATIONAcción

Tool to list localization entries by business from ProAbono via the HostedPages API. Use when you need to retrieve customizable text, HTML, or URL content for hosted pages with optional filtering by language, customization status, content, or code keywords. Returns paginated results with localization details.

Parámetros de entrada

  • Codestring

    Filter localizations by code keyword. Returns localizations containing the specified text in their code field.

  • Contentstring

    Filter localizations by content keyword. Returns localizations containing the specified text in their content field.

  • IsCustomboolean

    Filter for custom localizations. Set to true to retrieve only customized localizations, false for standard localizations.

  • Languagestring

    Filter localizations by language code (ISO 639-1 format, e.g., 'en', 'fr'). Returns only localizations matching this language.

  • IdBusinessintegerObligatorio

    ID of the business to retrieve localizations for. This is a required parameter.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List Customer MovesPROABONO_LIST_CUSTOMER_MOVESAcción

Tool to list all customer balance moves via the ProAbono Backoffice API. Use when you need to retrieve balance transactions, credits, debits, or billing movements for customers. Supports filtering by customer, billing status, and date range with pagination.

Parámetros de entrada

  • Pageinteger

    Page number for paginated results. Defaults to 1 if not specified.

  • Countboolean

    Whether to include total count in the response. Defaults to true.

  • Linksboolean

    Whether to generate HATEOAS links in the response. Defaults to true.

  • SizePageinteger

    Number of items per page. Maximum is 1000.

  • IdBusinessintegerObligatorio

    Your business ID. This is required to identify which business to query.

  • IdCustomerinteger

    Customer identifier to filter moves for a specific customer

  • IsNotBilledboolean

    Filter to show only unbilled moves (true) or all moves (false/null)

  • DateUpdateMinstring

    Filter moves updated after this date (ISO 8601 format: YYYY-MM-DDTHH:MM:SS)

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List CustomersPROABONO_LIST_CUSTOMERSAcción

Tool to list all customers from ProAbono via the Backoffice API. Use when you need to retrieve customer information with optional filtering by business, state, language, or creation date. Returns paginated results with customer details including ID, name, email, and status.

Parámetros de entrada

  • Languagestring

    Filter by language code (ISO 639-1 format, e.g., 'EN', 'FR')

  • StateLifestring

    Filter by state life status of the customer (e.g., 'Ok')

  • IdBusinessinteger

    Filter by Business ID to retrieve customers for a specific business

  • DateCreationMinstring

    Minimum creation date filter in ISO 8601 format (e.g., '2025-07-27T13:54:00')

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List Customers by FeaturePROABONO_LIST_CUSTOMERS_BY_FEATUREAcción

Tool to list customers that have access to a specific feature via the ProAbono API. Use when you need to identify which customers have subscriptions containing a particular feature. Returns feature-specific details including quota usage and billing period information. Note: Returns HTTP 204 (No Content) when no customers match the feature filter.

Parámetros de entrada

  • Pageinteger

    Page number for pagination (starts at 1)

  • SizePageinteger

    Number of results per page (default and maximum values are API-defined)

  • ReferenceFeaturestringObligatorio

    Reference of the Feature to filter customers having active subscriptions containing that specific feature

  • ReferenceSegmentstring

    Limit results to customers in a specific segment

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List DiscountsPROABONO_LIST_DISCOUNTSAcción

Tool to list all discounts from ProAbono's Backoffice API. Use when you need to retrieve discounts for a business, optionally filtering by state (Enabled/Draft).

Parámetros de entrada

  • IdBusinessinteger

    Filter by Business ID to retrieve discounts for a specific business

  • stateDiscountstring

    Filter by discount state. Use 'Enabled' for active discounts or 'Draft' for inactive ones

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List FeaturesPROABONO_LIST_FEATURESAcción

Tool to list all features via the ProAbono Backoffice API. Use when you need to retrieve features with optional filtering by business ID, lifecycle state, visibility, or creation date. Returns a paginated collection of feature objects.

Parámetros de entrada

  • IsVisibleboolean

    Filter by visibility status - true to show only visible features, false for hidden features

  • StateLifestring

    Filter by feature lifecycle state (e.g., 'Ok')

  • IdBusinessinteger

    Filter by Business ID to list features for a specific business

  • DateCreationMinstring

    Minimum creation date filter in ISO 8601 format (e.g., '2025-04-27T13:54:00')

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List Features (V1)PROABONO_LIST_FEATURES_V1Acción

Tool to retrieve all features from ProAbono API using the /v1/Features endpoint. Use when you need to get a list of all available features, optionally filtered by business ID.

Parámetros de entrada

  • id_businessstring

    Optional business ID filter parameter to retrieve features for a specific business

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List Gateway AccountsPROABONO_LIST_GATEWAY_ACCOUNTSAcción

Tool to list payment gateway accounts from ProAbono Backoffice API. Use when you need to retrieve gateway account information with optional filtering by business, currency, real money mode, or creation date. Returns paginated results with account details including ID, name, type, and state.

Parámetros de entrada

  • Currencystring

    Filter by currency code in ISO 4217 format (e.g., 'USD', 'EUR')

  • IdBusinessinteger

    Filter by Business ID to retrieve gateway accounts for a specific business

  • IsInRealMoneyboolean

    Filter by real money mode. Set to true for live accounts, false for test accounts.

  • DateCreationMinstring

    Minimum creation date filter in ISO 8601 format (e.g., '2023-07-27T13:54:00')

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List Gateway PermissionsPROABONO_LIST_GATEWAY_PERMISSIONSAcción

Tool to list gateway permissions from ProAbono API. Use when you need to retrieve payment permissions with optional filtering by business, customer, or creation date.

Parámetros de entrada

  • IdBusinessinteger

    Filter by Business ID. Use to retrieve permissions for a specific business entity.

  • IdCustomerinteger

    Filter by Customer ID. Use to retrieve permissions for a specific customer.

  • DateCreationMinstring

    Filter permissions created after this date. Must be in ISO 8601 format (e.g., '2023-07-27T13:54:00').

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List Gateway RequestsPROABONO_LIST_GATEWAY_REQUESTSAcción

Tool to list gateway requests from ProAbono. Use when you need to retrieve payment gateway request history with optional filtering by account, permission, transaction, dates, or request state. Returns paginated results with detailed information about each gateway request including status, amount, and timing.

Parámetros de entrada

  • id_businessinteger

    The business identifier. Optional parameter to scope the request to a specific business

  • StateRequeststring

    Filter by request state (e.g., 'Pending', 'Success', 'Failed')

  • DateUpdateMaxstring

    Filter to retrieve results updated before this date. Use ISO 8601 format (e.g., '2025-12-31T23:59:59')

  • DateUpdateMinstring

    Filter to retrieve results updated after this date. Use ISO 8601 format (e.g., '2025-07-27T13:54:00')

  • DateCreationMaxstring

    Filter to retrieve results created before this date. Use ISO 8601 format (e.g., '2025-12-31T23:59:59')

  • DateCreationMinstring

    Filter to retrieve results created after this date. Use ISO 8601 format (e.g., '2025-07-27T13:54:00')

  • IdGatewayAccountinteger

    Filter by specific gateway account identifier

  • IdGatewayPermissioninteger

    Filter by gateway permission identifier

  • IdGatewayTransactioninteger

    Filter by gateway transaction identifier

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List Gateway TransactionsPROABONO_LIST_GATEWAY_TRANSACTIONSAcción

Tool to list gateway transactions from ProAbono. Use when you need to retrieve payment gateway transaction records with optional filtering by business, customer, or update date. Returns paginated results with transaction details including status, amount, and payment type.

Parámetros de entrada

  • IdBusinessinteger

    Filter by Business ID to retrieve gateway transactions for a specific business

  • IdCustomerinteger

    Filter by Customer ID to retrieve gateway transactions for a specific customer

  • DateUpdateMinstring

    Minimum update date filter in ISO 8601 format (e.g., '2023-07-27T13:54:00'). Only transactions updated on or after this date will be returned

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List Invoice LinesPROABONO_LIST_INVOICE_LINESAcción

Tool to list all invoice lines from ProAbono via the Backoffice API. Use when you need to retrieve invoice line items with optional filtering by business, invoice, or minimum amount.

Parámetros de entrada

  • IdInvoiceinteger

    Filter by Invoice ID

  • IdBusinessinteger

    Filter by Business ID

  • AmountTotalDueMininteger

    Minimum total due amount filter (in cents)

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List Invoices and Credit NotesPROABONO_LIST_INVOICESAcción

Tool to list all invoices and credit notes from ProAbono Backoffice API. Use when you need to retrieve invoice data with optional filtering by business, payment state, or date range. Supports pagination for large result sets.

Parámetros de entrada

  • Pageinteger

    Page number for pagination (minimum 1).

  • SizePageinteger

    Number of items per page (minimum 1).

  • IdBusinessinteger

    Filter by Business ID to get invoices for a specific business.

  • StateInvoicestring

    Filter by invoice state (e.g., 'Paid', 'Due', 'Draft', 'Problem', 'Void', 'Uncollectible'). This is the technical state used internally by ProAbono.

  • DatePaymentMinstring

    Minimum payment date filter in ISO 8601 format (e.g., '2025-04-27T13:54:00'). Only invoices paid on or after this date will be returned.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List Invoices by Customer ReferencePROABONO_LIST_INVOICES_BY_CUSTOMERAcción

Tool to list invoices for a specific customer by their reference identifier from ProAbono API. Use when you need to retrieve all invoices associated with a particular customer using their unique reference from your application.

Parámetros de entrada

  • reference_customerstringObligatorio

    The unique reference of the customer whose invoices you want to retrieve. This is the identifier used within your own application.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List OffersPROABONO_LIST_OFFERSAcción

Tool to list all subscription offers (plans) from ProAbono Backoffice API. Use when you need to retrieve available offers with optional filtering by business, state, visibility, or update date.

Parámetros de entrada

  • IsVisibleboolean

    Filter offers by visibility status. Set to true to retrieve only visible offers, false for hidden ones.

  • StateLifestring

    Filter offers by lifecycle state. Common values include 'Ok' for active offers.

  • IdBusinessinteger

    Filter offers by Business ID. Use to retrieve offers for a specific business entity.

  • DateUpdateMinstring

    Filter offers updated after this date. Must be in ISO 8601 format (e.g., '2025-04-27T13:54:00').

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List PaymentsPROABONO_LIST_PAYMENTSAcción

Tool to list all payments from ProAbono Backoffice API. Use when you need to retrieve payments with optional filters by business, customer, or update date.

Parámetros de entrada

  • IdBusinessinteger

    Filter payments by Business ID

  • IdCustomerinteger

    Filter payments by Customer ID

  • DateUpdateMinstring

    Filter payments updated after this date (ISO 8601 format, e.g., 2025-07-27T13:54:00)

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List Pricing Table OffersPROABONO_LIST_PRICING_TABLE_OFFERSAcción

Tool to list all pricing table offers via the ProAbono Backoffice API. Use when you need to retrieve all offers configured in pricing tables for a specific business.

Parámetros de entrada

  • IdBusinessintegerObligatorio

    Your business ID. This is required to identify which business's pricing table offers to retrieve.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List Pricing TablesPROABONO_LIST_PRICING_TABLESAcción

Tool to list all pricing tables from ProAbono Backoffice API. Use when you need to retrieve pricing tables with optional filtering by business ID, visibility, or creation date.

Parámetros de entrada

  • IsVisibleboolean

    Filter by visibility status

  • IdBusinessinteger

    Filter by Business ID

  • DateCreationMinstring

    Minimum creation date filter in ISO 8601 format

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List Segment LocalizationsPROABONO_LIST_SEGMENT_LOCALIZATIONSAcción

Tool to list localization entries by segment from ProAbono Backoffice API. Use when you need to retrieve hosted page localizations for a specific segment with optional filtering by language, custom status, content, or code.

Parámetros de entrada

  • Codestring

    Search localizations by specific localization code

  • Contentstring

    Search localizations containing specified content text

  • IsCustomboolean

    Filter for customized localizations - true to show only custom localizations, false for default localizations

  • Languagestring

    Filter by specific language code (e.g., 'EN', 'FR')

  • IdSegmentintegerObligatorio

    The segment ID for which to retrieve localizations

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List SegmentsPROABONO_LIST_SEGMENTSAcción

Tool to list all segments from ProAbono via the Backoffice API. Use when you need to retrieve segments with optional filtering by business ID or currency. Returns a paginated collection of segment objects including configuration details, hosts, and navigation links.

Parámetros de entrada

  • Currencystring

    Filter by currency code (e.g., 'EUR', 'USD', 'GBP')

  • IdBusinessinteger

    Filter by Business ID to list segments for a specific business

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List Subscription DiscountsPROABONO_LIST_SUBSCRIPTION_DISCOUNTSAcción

Tool to list all subscription discounts via the ProAbono Backoffice API. Use when you need to retrieve discounts applied to subscriptions for a specific business. Returns paginated results with discount details including IDs, creation/update timestamps, and associated subscription and discount references.

Parámetros de entrada

  • IdBusinessintegerObligatorio

    Your business ID - required to retrieve subscription discounts for a specific business

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List Subscription FeaturesPROABONO_LIST_SUBSCRIPTION_FEATURESAcción

Tool to list all subscription features via the ProAbono Backoffice API. Use when you need to retrieve subscription features with optional filtering by Business ID, Feature ID, or minimum update date.

Parámetros de entrada

  • IdFeatureinteger

    Filter subscription features by Feature ID

  • IdBusinessinteger

    Filter subscription features by Business ID

  • DateUpdateMinstring

    Minimum update date filter in ISO 8601 format (e.g., 2025-08-27T13:54:00)

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List Subscription PeriodsPROABONO_LIST_SUBSCRIPTION_PERIODSAcción

Tool to list all subscription periods (billing cycles) from ProAbono Backoffice API. Use when you need to retrieve subscription period information with optional filtering by business ID, subscription ID, or start date. Supports pagination for large result sets.

Parámetros de entrada

  • IdBusinessinteger

    Filter by Business ID. Use this to retrieve subscription periods for a specific business.

  • DateStartMinstring

    Minimum start date filter in ISO 8601 format (e.g., '2025-08-27T13:54:00'). Returns periods that start on or after this date.

  • IdSubscriptioninteger

    Filter by Subscription ID. Use this to retrieve periods for a specific subscription.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List SubscriptionsPROABONO_LIST_SUBSCRIPTIONSAcción

Tool to list all subscriptions from ProAbono via the Backoffice API. Use when you need to retrieve subscription information with optional filtering by business, state, or start date. Returns paginated results with subscription details including customer, offer, dates, and status.

Parámetros de entrada

  • IdBusinessinteger

    Filter by Business ID to retrieve subscriptions for a specific business

  • dateStartMinstring

    Minimum start date filter in ISO 8601 format (e.g., '2025-04-27T13:54:00')

  • StateSubscriptionstring

    Filter by subscription technical state (e.g., 'ActiveRunning', 'Draft', 'Suspended', 'Ended')

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List Subscriptions (V1)PROABONO_LIST_SUBSCRIPTIONS_V1Acción

Tool to retrieve all subscriptions from ProAbono API using the /v1/Subscriptions endpoint. Use when you need to get a paginated list of all subscriptions, optionally filtered by business ID.

Parámetros de entrada

  • Pageinteger

    Page number for pagination, starting from 1

  • SizePageinteger

    Number of results per page for pagination

  • id_businessstring

    Optional business ID filter parameter to retrieve subscriptions for a specific business

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List Tax Profile ExceptionsPROABONO_LIST_TAX_PROFILE_EXCEPTIONSAcción

Tool to list tax profile exceptions from ProAbono Organization API. Use when you need to retrieve tax exceptions with optional filtering by business, tax profile, country, or region. Returns a paginated collection of tax exception records including rates, geographic scope, and applicability.

Parámetros de entrada

  • regionstring

    Filter by region or state code (e.g., 'US-CA' for California, 'US-TX' for Texas)

  • countrystring

    Filter by ISO 3166-1 alpha-2 country code (e.g., 'US', 'FR', 'GB')

  • id_businessinteger

    Filter by business identifier to retrieve tax profile exceptions for a specific business

  • id_tax_profileinteger

    Filter by tax profile identifier to retrieve exceptions for a specific tax profile

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List Tax ProfilesPROABONO_LIST_TAX_PROFILESAcción

Tool to list all tax profiles from ProAbono via the Backoffice API. Use when you need to retrieve tax configurations with optional filtering by business ID. Returns a paginated collection of tax profile objects with rates and settings.

Parámetros de entrada

  • IdBusinessinteger

    Filter by Business ID to list tax profiles for a specific business

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List Upgrade OffersPROABONO_LIST_UPGRADE_OFFERSAcción

Tool to retrieve offers available to upgrade an existing customer subscription. Use when you need to show upgrade options to a customer based on their current subscription status.

Parámetros de entrada

  • UpgradeOnlyboolean

    Filter to show only upgrade offers. When true, returns only offers that represent an upgrade from the customer's current subscription

  • ReferenceCustomerstringObligatorio

    The unique reference identifier of the customer to retrieve upgrade offers for

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List Webhook NotificationsPROABONO_LIST_WEBHOOK_NOTIFICATIONSAcción

Tool to list webhook notifications from ProAbono via the Notification API. Use when you need to retrieve webhook notification history with optional filtering by business, segment, date range, state, or webhook ID. Returns paginated results with notification details including sending status and related resources.

Parámetros de entrada

  • IdSegmentinteger

    Filter by specific segment identifier to retrieve notifications for a particular segment only

  • IdWebhookinteger

    Filter by webhook identifier to retrieve notifications for a specific webhook only

  • StateLifestring

    Filter by specific state of the webhook notification (e.g., 'Ok', 'Failed')

  • IdBusinessintegerObligatorio

    Your business identifier. Required to retrieve webhook notifications for a specific business.

  • DateUpdateMaxstring

    Notifications updated before this date in ISO 8601 format. Use to filter by maximum update date.

  • DateUpdateMinstring

    Notifications updated after this date in ISO 8601 format. Use to filter by minimum update date.

  • DateCreationMaxstring

    Notifications created before this date in ISO 8601 format (e.g., '2025-12-31T23:59:59'). Use to filter by maximum creation date.

  • DateCreationMinstring

    Notifications created after this date in ISO 8601 format (e.g., '2025-07-27T13:54:00'). Use to filter by minimum creation date.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List WebhooksPROABONO_LIST_WEBHOOKSAcción

Tool to list webhooks from ProAbono Notification API. Use when you need to retrieve configured webhooks with optional filtering by creation date, update date, or state.

Parámetros de entrada

  • StateLifestring

    Filter webhooks by state. Common values include 'Ok' for active webhooks and 'DisabledUser' for disabled webhooks.

  • IdBusinessintegerObligatorio

    Your business identifier. This is a required parameter to identify which business's webhooks to retrieve.

  • DateUpdateMaxstring

    Filter webhooks updated before a specific date. Must be in ISO 8601 format (e.g., '2025-04-27T23:59:59').

  • DateUpdateMinstring

    Filter webhooks updated after a specific date. Must be in ISO 8601 format (e.g., '2025-04-27T13:54:00').

  • DateCreationMaxstring

    Filter webhooks created before a specific date. Must be in ISO 8601 format (e.g., '2025-04-27T13:54:00').

  • DateCreationMinstring

    Filter webhooks created after a specific date. Must be in ISO 8601 format (e.g., '2025-04-27T13:54:00').

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Quote Balance Line CreationPROABONO_QUOTE_BALANCE_LINEAcción

Tool to get a pricing quote for creating a balance line (one-time charge or credit). Use when you need to calculate the total amount including taxes before creating a balance line for a customer.

Parámetros de entrada

  • LabelstringObligatorio

    Description or label for the balance line item. This will appear on invoices and billing statements.

  • AmountintegerObligatorio

    Amount in the smallest currency unit (e.g., cents for USD, pennies for GBP). For example, $15.00 would be 1500.

  • EnsureBillableboolean

    If true (default), validates that the customer has valid payment information configured. The quote endpoint requires valid payment settings regardless of this parameter value.

  • ReferenceCustomerstringObligatorio

    The unique reference of the customer for whom to calculate the balance line pricing. This is the customer identifier shared between your application and ProAbono.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Revoke Customer Portal LinksPROABONO_REVOKE_CUSTOMER_LINKSAcción

Tool to revoke encrypted customer portal links and generate new ones in ProAbono. Use when you need to invalidate previously generated customer portal links for security purposes (e.g., after a potential link compromise or as part of security best practices).

Parámetros de entrada

  • reference_customerstringObligatorio

    The unique reference identifier of the customer whose portal links should be revoked

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update Business Billing AddressPROABONO_UPDATE_BUSINESSES_BILLING_ADDRESSAcción

Tool to update business billing address via the Backoffice API. Use when you need to modify billing information including company name, contact details, address lines, and tax information for a specific business.

Parámetros de entrada

  • IdintegerObligatorio

    Business identifier whose billing address to update

  • Citystring

    City name

  • Phonestring

    Contact phone number

  • Regionstring

    Region stands for Subdivision, Department, Region, Province, State. Note: Region field may have business rule restrictions preventing updates.

  • Companystring

    Name of the company billing customers

  • Countrystring

    Two-letter country code per ISO 3166-1 alpha-2. Note: Country field may have business rule restrictions preventing updates.

  • ZipCodestring

    Postal code

  • LastNamestring

    Individual name or department contact

  • FirstNamestring

    Individual name or department contact

  • AddressLine1string

    Primary address line

  • AddressLine2string

    Secondary address line (floor, suite, building, etc.)

  • TaxInformationstring

    VAT/TAX identification number

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update CustomerPROABONO_UPDATE_CUSTOMERAcción

Tool to update an existing customer in ProAbono via the Backoffice API. Use when you need to modify customer properties such as name, email, or language preferences. Allows partial updates.

Parámetros de entrada

  • IdintegerObligatorio

    The unique identifier of the customer to update

  • Namestring

    Display name of the customer. Use this to update the customer's full name

  • Emailstring

    Customer's email address. Use this to update the customer's contact email

  • Languagestring

    Customer's preferred language in ISO 639-1 format (2-letter code). Use this to update the customer's language preference

  • IdBusinessinteger

    The business identifier. Optional parameter to scope the request to a specific business

  • ReferenceCustomerstring

    Your custom reference for the customer shared between ProAbono and your application

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update Customer Billing AddressPROABONO_UPDATE_CUSTOMER_BILLING_ADDRESSAcción

Tool to update the billing address for a customer in ProAbono via the API. Use when you need to modify billing address information including company name, contact details, address lines, and tax information. Once updated, ProAbono will use this information for future invoices.

Parámetros de entrada

  • Citystring

    City name of the billing address

  • Phonestring

    Phone number for the billing address

  • Regionstring

    ISO 3166-2 region code representing subdivision, department, region, province, or state. Required for certain countries like US (e.g., CA for California), optional for others like FR.

  • Companystring

    Name of the company for billing purposes

  • Countrystring

    ISO 3166-1 alpha-2 country code of the billing address (e.g., FR for France, US for United States)

  • ZipCodestring

    Postal code or ZIP code of the billing address

  • LastNamestring

    Last name of the billing address holder

  • FirstNamestring

    First name of the billing address holder

  • AddressLine1string

    Primary address line of the billing address

  • AddressLine2string

    Secondary address line (optional, for apartment, suite, etc.)

  • TaxInformationstring

    Tax information such as VAT ID, Num TVA Intra, GST, or other tax identification number

  • reference_customerstringObligatorio

    The unique reference of the customer whose billing address to update. This is the shared identifier between ProAbono and your application.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update Customer Payment SettingsPROABONO_UPDATE_CUSTOMER_PAYMENT_SETTINGSAcción

Tool to update payment settings for a specific customer in ProAbono. Use when you need to set a customer's payment method preference or update their billing configuration.

Parámetros de entrada

  • TypePaymentstring

    The manual payment method type to set. Possible values: Card, ExternalBank, ExternalCash, ExternalCheck, ExternalOther. When set, payment collection becomes your responsibility

  • ReferenceCustomerstringObligatorio

    The unique reference identifier of the customer whose payment settings you want to update

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update Customer Shipping AddressPROABONO_UPDATE_CUSTOMER_SHIPPINGAcción

Tool to update customer shipping address via the Backoffice API. Use when you need to modify shipping information including company name, contact details, address lines, and tax information for a specific customer.

Parámetros de entrada

  • IdintegerObligatorio

    The customer ID whose shipping address to update

  • Citystring

    City name

  • Phonestring

    Phone number

  • Regionstring

    ISO 3166-2 region/province code

  • Companystring

    Company name

  • Countrystring

    ISO 3166-1 alpha-2 country code

  • ZipCodestring

    Postal code

  • LastNamestring

    Last name

  • FirstNamestring

    First name

  • IdBusinessintegerObligatorio

    Your Business ID

  • AddressLine1string

    Primary address line

  • AddressLine2string

    Secondary address line

  • TaxInformationstring

    VAT ID or tax identifier

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update FeaturePROABONO_UPDATE_FEATUREAcción

Tool to update an existing feature in ProAbono via the Backoffice API. Use when you need to modify feature properties such as name, visibility, type, or display order.

Parámetros de entrada

  • idintegerObligatorio

    ID of the feature to update

  • Namestring

    The feature name displayed to users

  • Orderinteger

    Display position among other features (lower numbers appear first)

  • IsVisibleboolean

    Whether to show this feature in offers and hosted pages

  • IdBusinessinteger

    Your Business identifier

  • TypeFeaturestringenum

    Feature type enumeration.

    OnOffLimitationConsumption
  • ReferenceFeaturestring

    Shared key between ProAbono and your system for identifying this feature

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update Tax ProfilesPROABONO_UPDATE_TAX_PROFILESAcción

Tool to update an existing tax profile in ProAbono via the Backoffice API. Use when you need to modify tax profile properties such as name, description, label, or tax rates.

Parámetros de entrada

  • IdintegerObligatorio

    The ID of the tax profile to update

  • Namestring

    Name of the tax profile to update

  • Labelstring

    Display label for the tax (maximum 10 characters)

  • IdBusinessintegerObligatorio

    The ID of the business

  • Descriptionstring

    Description of the tax profile to provide additional context

  • RateDefaultinteger

    Default tax rate in basis points (e.g., 2500 for 25%, 2000 for 20%). Must be a non-negative integer

  • TypeRateTaxstring

    Type of tax rate applied (e.g., 'Standard', 'Reduced', 'Outside', 'Zero')

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not