Soldo Software and Services Workflows API
The Workflows API from Soldo Software and Services — 3 operation(s) for workflows.
The Workflows API from Soldo Software and Services — 3 operation(s) for workflows.
openapi: 3.0.1
info:
title: Soldo Business API v2.0 - OpenAPI 3.0 Accounting Classification Workflows API
description: Soldo Business API v2.0 OpenAPI 3.0 specification
version: 5.56.0
servers:
- url: https://api.soldo.com
description: Production server (using live data)
- url: https://api-demo.soldocloud.net
description: Sandbox server (using test data)
tags:
- name: Workflows
paths:
/business/v2/workflows:
get:
tags:
- Workflows
summary: Search Workflows
description: Endpoint to search `Workflows`.
operationId: workflow-search
parameters:
- name: status
in: query
description: The status of the `Workflow`.
schema:
type: array
description: The status of the `Workflow`.
items:
$ref: '#/components/schemas/WorkflowStatusSearch'
example: ACTIVE
- name: targetTypes
in: query
description: The type of the `Workflow`.
schema:
type: array
description: The type of the `Workflow`.
items:
$ref: '#/components/schemas/WorkflowTargetType'
example: USER
- name: text
in: query
description: A simple text to search `Workflow` by `name` or `description`.
schema:
type: string
description: A simple text to search `Workflow` by `name` or `description`.
example: Workflow
example: Workflow
- name: p
in: query
description: '0'
schema:
type: integer
description: It indicates the specific page to display (the counter starts from zero).
format: int32
example: 3
default: 0
example: 3
- name: s
in: query
description: It indicates the number of items per page.
schema:
maximum: 50
type: integer
description: It indicates the number of items per page.
format: int32
example: 25
default: 0
example: 25
- name: props
in: query
schema:
type: array
description: It indicates the sorting direction applied to the above parameters. To apply a sorting on multiple parameters, set as many times the `props` parameter in the request.
example: creationTime
items:
type: string
description: It indicates the sorting direction applied to the above parameters. To apply a sorting on multiple parameters, set as many times the `props` parameter in the request.
example: creationTime
responses:
'200':
description: The result is an array containing `Workflows`.
content:
application/json:
schema:
$ref: '#/components/schemas/Workflows'
'400':
description: Your request has missing arguments or is malformed.
security:
- standardAuth:
- workflow_read
post:
tags:
- Workflows
summary: Add Workflow
description: Endpoint to add a new `Workflow`.
operationId: workflow-add
requestBody:
description: Workflow creation parameters.
content:
application/json:
schema:
$ref: '#/components/schemas/CreateWorkflow'
responses:
'200':
description: The created `Workflow`.
content:
application/json:
schema:
$ref: '#/components/schemas/Workflow'
'400':
description: Your request has missing arguments or is malformed.
security:
- standardAuth:
- workflow_write
/business/v2/workflows/{workflowId}:
get:
tags:
- Workflows
summary: Get Workflow
description: Endpoint to get a specific `Workflow` by ID.
operationId: workflow-get
parameters:
- name: workflowId
in: path
description: The workflow ID.
required: true
schema:
type: string
example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
responses:
'200':
description: The result is a single `Workflow`.
content:
application/json:
schema:
$ref: '#/components/schemas/Workflow'
'404':
description: One or more resource requested does not exist.
security:
- standardAuth:
- workflow_read
put:
tags:
- Workflows
summary: Update Workflow
description: Endpoint to update an existing `Workflow`,for some types, this might generate a new ID.
operationId: workflow-update
parameters:
- name: workflowId
in: path
required: true
schema:
type: string
description: The workflow ID.
example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateWorkflow'
responses:
'200':
description: The updated `Workflow`.
content:
application/json:
schema:
$ref: '#/components/schemas/Workflow'
'400':
description: Your request has missing arguments or is malformed.
'404':
description: One or more resource requested does not exist.
security:
- standardAuth:
- workflow_write
delete:
tags:
- Workflows
summary: 'Delete Workflow '
description: Endpoint to delete a `Workflow`.
operationId: workflow-delete
parameters:
- name: workflowId
in: path
required: true
schema:
type: string
description: The `Workflow` ID.
example: ' 2d9f6514-4004-4122-b7f2-dcf7e034741c'
responses:
'204':
description: No content as result.
'404':
description: One or more resource requested does not exist.
security:
- standardAuth:
- workflow_write
/business/v2/workflows/{workflowId}/status:
put:
tags:
- Workflows
summary: Update Workflow Status
description: Endpoint to update a specific `Workflow` status (ACTIVE, DEACTIVATED, DELETED).
operationId: workflow-status-update
parameters:
- name: workflowId
in: path
required: true
schema:
type: string
description: The workflow ID.
example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateWorkflowStatus'
responses:
'204':
description: No content as result.
'404':
description: One or more resource requested does not exist.
security:
- standardAuth:
- workflow_write
components:
schemas:
WorkflowReviewerInfo:
required:
- ids
type: object
properties:
ids:
type: array
description: The ID of the reviewers (only required in case of reviewer of type `ROLE` and `USER`).
example:
- 7bf79328-a7ae-4222-aa54-091ff7f429a7
- 2d65bd5e-3fdf-4002-b166-bde7fb8863fa
items:
type: string
description: The ID of the reviewers (only required in case of reviewer of type `ROLE` and `USER`).
example: '["7bf79328-a7ae-4222-aa54-091ff7f429a7","2d65bd5e-3fdf-4002-b166-bde7fb8863fa"]'
description: One or more IDs to identify who can review this step (only required in case of reviewer of type `ROLE` and `USER`).
WorkflowTargetType:
type: string
description: The type of the `Workflow`.
example: FUNDS
enum:
- FUNDS
- GOODS_AND_SERVICES
- TRIP
PersistVisibility:
required:
- type
- value
type: object
properties:
type:
$ref: '#/components/schemas/VisibilityOwnerType'
value:
type: array
description: One or more values that identify the visibility condition. If the type is `USER`, the value must be `ALL`.
example:
- 7bf79328-a7ae-4222-aa54-091ff7f429a7
- 2d65bd5e-3fdf-4002-b166-bde7fb8863fa
items:
type: string
description: One or more values that identify the visibility condition. If the type is `USER`, the value must be `ALL`.
example: '["7bf79328-a7ae-4222-aa54-091ff7f429a7","2d65bd5e-3fdf-4002-b166-bde7fb8863fa"]'
description: Workflow visibility definition. This field contains the list of users that are able to see this workflow. To grant access to all users, pass an empty list or -1.
UpdateWorkflow:
required:
- steps
- target_type
- visibilities
type: object
properties:
name:
type: string
description: The name of the `Workflow`.
example: Workflow
description:
type: string
description: The description of the `Workflow`.
example: My Workflow Description
policy_url:
type: string
description: The URL of the policy document for the `Workflow`.
example: https://www.example.com/policy.pdf
steps:
type: array
description: The ordered set of workflow steps, where each step includes its configuration and the reviewers assigned for approval or review actions.
items:
$ref: '#/components/schemas/WorkflowProcessStep'
visibilities:
type: array
description: Workflow visibility definition. This field contains the list of users that are able to see this workflow. To grant access to all users, pass an empty list or -1.
items:
$ref: '#/components/schemas/PersistVisibility'
target_type:
$ref: '#/components/schemas/WorkflowTargetType'
description: Base schema for workflow update. The actual fields depend on the `target_type`.
discriminator:
propertyName: target_type
mapping:
FUNDS: '#/components/schemas/UpdateFundWorkflow'
GOODS_AND_SERVICES: '#/components/schemas/UpdateGoodsServicesWorkflow'
TRIP: '#/components/schemas/UpdateTripWorkflow'
WorkflowStatus:
type: string
description: The status of the `Workflow`.
enum:
- ACTIVE
- DEACTIVATED
- DELETED
WorkflowProcessStep:
required:
- reviewer_type
- step_number
type: object
properties:
step_number:
minimum: 1
type: integer
description: A number which identifies the order of the step. The first step should start with `1`, the following steps number should be previous `step_number + 1` without any gap.
format: int32
example: 2
default: 1
reviewer_type:
$ref: '#/components/schemas/WorkflowReviewerType'
reviewer_info:
$ref: '#/components/schemas/WorkflowReviewerInfo'
automation_rule:
$ref: '#/components/schemas/WorkflowAutomationRule'
description: The ordered set of workflow steps, where each step includes its configuration and the reviewers assigned for approval or review actions.
WorkflowAmountCondition:
required:
- amount
- operator
type: object
properties:
amount:
type: number
description: The amount a transaction must exceed / not exceed in order to satisfy the condition.
example: 10.25
operator:
$ref: '#/components/schemas/WorkflowComparator'
description: A condition based on the transaction amount.
WorkflowItem:
type: object
properties:
id:
type: string
description: The `Workflow` ID.
example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
name:
type: string
description: The name of the `Workflow`.
example: Workflow
description:
type: string
description: The description of the `Workflow`.
example: My Workflow Description
status:
$ref: '#/components/schemas/WorkflowStatus'
target_type:
$ref: '#/components/schemas/WorkflowTargetType'
steps_count:
type: integer
description: The number of steps in the `Workflow`.
format: int32
example: 1
CreateWorkflow:
required:
- description
- name
- steps
- target_type
- visibilities
type: object
properties:
name:
type: string
description: The name of the `Workflow`.
example: Workflow
description:
type: string
description: The description of the `Workflow`.
example: My Workflow Description
policy_url:
type: string
description: The URL of the policy document for the `Workflow`.
example: https://www.example.com/policy.pdf
steps:
type: array
description: The ordered set of workflow steps, where each step includes its configuration and the reviewers assigned for approval or review actions.
items:
$ref: '#/components/schemas/WorkflowProcessStep'
visibilities:
type: array
description: Workflow visibility definition. This field contains the list of users that are able to see this workflow. To grant access to all users, pass an empty list or -1.
items:
$ref: '#/components/schemas/PersistVisibility'
target_type:
$ref: '#/components/schemas/WorkflowTargetType'
description: Base schema for workflow creation. The actual fields depend on the `target_type`.
discriminator:
propertyName: target_type
mapping:
FUNDS: '#/components/schemas/CreateFundsWorkflow'
GOODS_AND_SERVICES: '#/components/schemas/CreateGoodsServicesWorkflow'
TRIP: '#/components/schemas/CreateTripWorkflow'
Workflows:
type: object
properties:
total:
type: integer
description: It represents the total number of available items in the list.
format: int32
example: 168
pages:
type: integer
description: It represents the total number of available pages.
format: int32
example: 7
page_size:
type: integer
description: It represents the number of items per page.
format: int32
example: 25
current_page:
type: integer
description: It indicates the current page (the counter starts from zero).
format: int32
example: 0
results_size:
type: integer
description: It indicates the size of the array results.
format: int32
example: 25
results:
type: array
items:
$ref: '#/components/schemas/WorkflowItem'
WorkflowComparator:
type: string
description: The logical operator to be used in relationship to the transaction amount.
example: LOWER_EQUAL
enum:
- HIGHER_EQUAL
- LOWER_EQUAL
WorkflowReviewerType:
type: string
description: The type of reviewer who can review this step.
example: USER
enum:
- LINE_MANAGER
- ROLE
- USER
WorkflowStepStatus:
type: string
description: The status of the expense in case the conditions of the automation rules are satisfied.
example: PARTIALLY_APPROVED
enum:
- APPROVED
- PARTIALLY_APPROVED
- DECLINED
Workflow:
required:
- steps
- visibilities
type: object
properties:
id:
type: string
description: The `Workflow` ID.
example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
name:
type: string
description: The name of the `Workflow`.
example: Workflow
description:
type: string
description: The description of the `Workflow`.
example: My Workflow Description
policy_url:
type: string
description: The URL of the policy document for the `Workflow`.
example: https://www.example.com/policy.pdf
status:
$ref: '#/components/schemas/WorkflowStatus'
target_type:
$ref: '#/components/schemas/WorkflowTargetType'
priority:
type: integer
description: The priority of the `Workflow`.
format: int32
example: 1
steps_count:
type: integer
description: The number of steps in the `Workflow`.
format: int32
example: 1
steps:
type: array
description: The ordered set of workflow steps, where each step includes its configuration and the reviewers assigned for approval or review actions.
items:
$ref: '#/components/schemas/WorkflowProcessStep'
visibilities:
type: array
description: Workflow visibility definition. This field contains the list of users that are able to see this workflow. To grant access to all users, pass an empty list or -1.
items:
$ref: '#/components/schemas/PersistVisibility'
description: Base schema for workflow. The actual fields depend on the `target_type`.
discriminator:
propertyName: target_type
WorkflowStatusSearch:
type: string
description: The status of the `Workflow`.
enum:
- ACTIVE
- INACTIVE
UpdateWorkflowStatus:
required:
- status
type: object
properties:
status:
$ref: '#/components/schemas/WorkflowStatus'
description: Status update parameters.
VisibilityOwnerType:
type: string
description: The type of user or group that can see this workflow.
example: ACTIVE
enum:
- USER
WorkflowAutomationRule:
required:
- expense_status
- required_info
type: object
properties:
expense_status:
$ref: '#/components/schemas/WorkflowStepStatus'
required_info:
type: boolean
description: A boolean to define whether a transaction should have all the required info (as defined on the Reminders feature) completed.
example: true
default: false
amount_condition:
$ref: '#/components/schemas/WorkflowAmountCondition'
description: An automation to automatically review the step when certain conditions are met.
securitySchemes:
standardAuth:
type: oauth2
description: This API uses OAuth 2 with the "Client Credentials" grant flow.
flows:
clientCredentials:
tokenUrl: https://api.soldo.com/oauth/authorize
scopes:
address_read: Can read address details.
address_write: Can update address details.
card_read: Can read card details.
card_write: Can change card details.
company_read: Can read company details.
company_write: Can change company details.
contact_read: Can read contact details.
contact_write: Can change contact details.
employee_read: Can read employee details.
employee_write: Can change employee details.
expense_category_read: Can read expense category details.
expense_category_write: Can change expense category details.
expense_report_read: Can read expense report details.
expense_report_write: Can change expense report details.
expense_review_read: Can read expense review status.
expense_review_write: Can change expense review status.
group_read: Can read group details.
group_write: Can change groups details.
online_ads_read: Can read online ads details.
online_ads_write: Can change online ads details.
payment_read: Can read payment details.
payment_write: Can change payment details.
purchase_read: Can read purchase details.
purchase_write: Can change purchase details.
refueling_read: Can read refueling details.
refueling_write: Can change refueling details.
resource_set_read: Can read resource set details.
resource_set_write: Can change resource set details.
role_read: Can read role details.
statement_read: Can read statement details.
subscription_read: Can read subscription details.
subscription_write: Can change subscription details.
tag_read: Can read tags.
tag_write: can change tags.
tax_rate_read: Can read vat rate details.
tax_rate_write: Can change vat rate details.
transaction_read: Can read transaction details.
transaction_write: Can change transaction details.
vehicle_read: Can read vehicle details.
vehicle_write: Can change vehicle details.
wallet_read: Can read wallet details.
wallet_write: Can change wallet details.
webhook_subscription_read: Can read webhook subscription details.
webhook_subscription_write: Can change webhook subscription details.
x-webhooks:
move_resources_card:
post:
tags:
- Webhooks
- Groups
summary: Group - Move Resources Card
description: A `Card` has been moved to another `Group`.
operationId: webhook-group-move-resources-card
parameters:
- name: X-Soldo-Fingerprint
in: header
required: true
schema:
type: string
default: '{{fingerprint}}'
description: '[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.'
example: '{{fingerprint}}'
- name: X-Soldo-Fingerprint-Order
in: header
required: true
schema:
type: string
default: id, name, type, customReferenceId
description: '[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.'
example: id, name, type, customReferenceId
- name: X-Soldo-Fingerprint-Signature
in: header
required: true
schema:
type: string
default: '{{fingerprint_signature}}'
description: '[Webhook authentication](ref:webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](ref:soldo-public-key).'
example: '{{fingerprint_signature}}'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/MoveResourcesCardEvent'
responses:
'200':
description: Success.
x-soldo:
fingerprint-order: id, name, type, customReferenceId
move_resources_wallet:
post:
tags:
- Webhooks
- Groups
summary: Group - Move Resources Wallet
description: A `Wallet` is moved to another `Group`.
operationId: webhook-group-move-resources-wallet
parameters:
- name: X-Soldo-Fingerprint
in: header
required: true
schema:
type: string
default: '{{fingerprint}}'
description: '[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.'
example: '{{fingerprint}}'
- name: X-Soldo-Fingerprint-Order
in: header
required: true
schema:
type: string
default: id, name, type, customReferenceId
description: '[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.'
example: id, name, type, customReferenceId
- name: X-Soldo-Fingerprint-Signature
in: header
required: true
schema:
type: string
default: '{{fingerprint_signature}}'
description: '[Webhook authentication](ref:webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](ref:soldo-public-key).'
example: '{{fingerprint_signature}}'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/MoveResourcesWalletEvent'
responses:
'200':
description: Success.
x-soldo:
fingerprint-order: id, name, type, customReferenceId
customer_care_withdraw:
post:
tags:
- Webhooks
- Transactions
summary: Transaction - Customer Care Withdraw
description: A `Withdrawal` has been performed by customer care support
operationId: webhook-transaction-customer-care-withdraw
parameters:
- name: X-Soldo-Fingerprint
in: header
required: true
schema:
type: string
default: '{{fingerprint}}'
description: '[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.'
example: '{{fingerprint}}'
- name: X-Soldo-Fingerprint-Order
in: header
required: true
schema:
type: string
default: id, walletId, status, transactionSign
description: '[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.'
example: id, walletId, status, transactionSign
- name: X-Soldo-Fingerprint-Signature
in: header
required: true
schema:
type: string
default: '{{fingerprint_signature}}'
description: '[Webhook authentication](ref:webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](ref:soldo-public-key).'
example: '{{fingerprint_signature}}'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CustomerCareWithdrawEvent'
responses:
'200':
description: Success.
x-soldo:
fingerprint-order: id, walletId, status, transactionSign
transaction_business_trip_unlinked:
post:
tags:
- Webhooks
- Transactions
summary: Transaction - Transaction Business Trip Unlinked
description: A `Transaction` has been unlinked from a `BusinessTrip`.
operationId: webhook-transaction-transaction-business-trip-unlinked
parameters:
- name: X-Soldo-Fingerprint
in: header
required: true
schema:
type: string
default: '{{fingerprint}}'
description: '[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.'
example: '{{fingerprint}}'
- name: X-Soldo-Fingerprint-Order
in: header
required: true
schema:
type: string
default: id, walletId, status, transactionSign
description: '[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.'
example: id, walletId, status, transactionSign
- name: X-Soldo-Fingerprint-Signature
in: header
required: true
schema:
type: string
default: '{{fingerprint_signature}}'
description: '[Webhook authentication](ref:webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](ref:soldo-public-key).'
example: '{{fingerprint_signature}}'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TransactionBusinessTripUnlinkedEvent'
responses:
'200':
description: Success.
x-soldo:
fingerprint-order: id, walletId, status, transactionSign
remove_resources_card:
post:
tags:
- Webhooks
- Groups
summary: Group - Remove Resources Card
description: A `Card` has been removed from a `Group`.
operationId: webhook-group-remove-resources-card
parameters:
- name: X-Soldo-Fingerprint
in: header
required: true
schema:
type: string
default: '{{fingerprint}}'
description: '[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.'
example: '{{fingerprint}}'
- name: X-Soldo-Fingerprint-Order
in: header
required: true
schema:
type: string
default: id, name, type, customReferenceId
description: '[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.'
example: id, name, type, customReferenceId
- name: X-Soldo-Fingerprint-Signature
in: header
required: true
schema:
type: string
default: '{{fingerprint_signature}}'
description: '[Webhook authentication](ref:webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](ref:soldo-public-key).'
example: '{{fingerprint_signature}}'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RemoveResourcesCardEvent'
responses:
'200':
description: Success.
x-soldo:
fingerprint-order: id, name, type, customReferenceId
load_failed:
post:
tags:
- Webhooks
- Transactions
summary: Transaction - Load Failed
description: A money load for company `Wallet` failed.
operationId: webhook-transaction-load-failed
parameters:
- name: X-Soldo-Fingerprint
in: header
required: true
schema:
type: string
default: '{{fingerprint}}'
description: '[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.'
example: '{{fingerprint}}'
- name: X-Soldo-Fingerprint-Order
in: header
required: true
schema:
type: string
default: id, walletId, status, transactionSign
description: '[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.'
example: id, walletId, status, transactionSign
- name: X-Soldo-Fingerprint-Signature
in: header
required: true
schema:
type: string
default: '{{fingerprint_signature}}'
description: '[Webhook authentication](ref:webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](ref:soldo-public-key).'
example: '{{fingerprint_signature}}'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/LoadFailedEvent'
responses:
'200':
description: Success.
x-soldo:
fingerprint-order: id, walletId, status, transactionSign
created_expense_configuration:
post:
tags:
- Webhooks
- Expense Review Configuration
summary: Expense Review - Configuration Created
description: An `ExpenseReview` configuration has been created`.
operationId: webhook-expensereview-created-expense-configuration
parameters:
- name: X-Soldo-Fingerprint
in: header
required: true
schema:
type: string
default: '{{fingerprint}}'
description: '[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.'
example: '{{fingerprint}}'
- name: X-Soldo-Fingerprint-Order
in: header
required: true
schema:
type: string
default: startDate, policyUrl, enabled, transactionId
description: '[Webhook authenti
# --- truncated at 32 KB (154 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/soldo-software-and-services/refs/heads/main/openapi/soldo-software-and-services-workflows-api-openapi.yml