{"openapi":"3.1.0","info":{"title":"Soldo Business API v2.0","description":"Soldo Business API v2.0 OpenAPI specification","version":"4.45.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)"}],"paths":{"/oauth/authorize":{"post":{"tags":["Authentication"],"summary":"Authenticate","description":"Grant access to the API getting an `OAuth2Token`.","operationId":"authorize","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"client_id":{"type":"string","description":"The client ID issued while [Setting up the API](doc:api-set-up), this works as a username.","example":"{{client_id}}"},"client_secret":{"type":"string","description":"The client secret issued while [Setting up the API](doc:api-set-up), this works as a password.","example":"{{client_secret}}"}},"required":["client_id","client_secret"]}}}},"responses":{"200":{"description":"The `OAuth2Token`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OAuth2Token"}}}},"400":{"description":"Your request has missing arguments or is malformed."},"403":{"description":"The access token you are using is not granted with the necessary permissions or is expired. Check client scopes and fingerprint requirements."}}}},"/business/v2/online-ads/{onlineAdId}":{"get":{"tags":["Online Ads"],"summary":"Get Online Ads","description":"Endpoint to get a specific `OnlineAd` by ID.","operationId":"online-ads-get","parameters":[{"name":"onlineAdId","in":"path","required":true,"schema":{"type":"string","description":"The `OnlineAd` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}}],"responses":{"200":{"description":"The result is a single `OnlineAd`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OnlineAds"}}}},"400":{"description":"Your request has missing arguments or is malformed."}},"security":[{"standardAuth":["online_ads_read"]}]},"put":{"tags":["Online Ads"],"summary":"Update Online Ads","description":"Endpoint to update a specific `OnlineAd`.","operationId":"online-ads-update","parameters":[{"name":"onlineAdId","in":"path","required":true,"schema":{"type":"string","description":"The `OnlineAd` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}},{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Advanced authentication](ref:advanced-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","example":"{{fingerprint}}"}},{"name":"X-Soldo-Fingerprint-Signature","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint_signature}}","description":"[Advanced authentication](ref:advanced-authentication): Signature of the `X-Soldo-Fingerprint`.","example":"{{fingerprint_signature}}"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateOnlineAds"}}}},"responses":{"200":{"description":"The returned resource is a single `OnlineAd`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OnlineAds"}}}},"400":{"description":"Your request has missing arguments or is malformed."}},"security":[{"standardAuth":["online_ads_write"]}],"x-soldo":{"fingerprint-order":"id, name, wallet_id, token"}},"post":{"tags":["Online Ads"],"summary":"Activate Online Ads","description":"Endpoint to activate a specific `OnlineAd`.","operationId":"online-ads-activate","parameters":[{"name":"onlineAdId","in":"path","required":true,"schema":{"type":"string","description":"The `OnlineAd` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}},{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Advanced authentication](ref:advanced-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","example":"{{fingerprint}}"}},{"name":"X-Soldo-Fingerprint-Signature","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint_signature}}","description":"[Advanced authentication](ref:advanced-authentication): Signature of the `X-Soldo-Fingerprint`.","example":"{{fingerprint_signature}}"}}],"responses":{"200":{"description":"The `Order` of the reserved `Card` for the `OnlineAd`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Order"}}}},"400":{"description":"Your request has missing arguments or is malformed."}},"security":[{"standardAuth":["online_ads_write"]}],"x-soldo":{"fingerprint-order":"id, token"}},"delete":{"tags":["Online Ads"],"summary":"Delete Online Ads","description":"Endpoint to delete a specific `OnlineAd`.","operationId":"online-ads-delete","parameters":[{"name":"onlineAdId","in":"path","required":true,"schema":{"type":"string","description":"The `OnlineAd` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}}],"responses":{"204":{"description":"No content as result."},"400":{"description":"Your request has missing arguments or is malformed."}},"security":[{"standardAuth":["online_ads_write"]}]}},"/business/v2/subscriptions/{subscriptionId}":{"get":{"tags":["Subscriptions"],"summary":"Get Subscription","operationId":"subscription-get","parameters":[{"name":"subscriptionId","in":"path","required":true,"schema":{"type":"string","description":"The `Subscription` ID","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}}],"responses":{"200":{"description":"The returned resource is a `Subscription`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Subscription"}}}},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["subscription_read"]}]},"put":{"tags":["Subscriptions"],"summary":"Update Subscription","description":"Endpoint to update a specific `Subscription`.","operationId":"subscription-update","parameters":[{"name":"subscriptionId","in":"path","required":true,"schema":{"type":"string","description":"The `Subscription` id.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}},{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Advanced authentication](ref:advanced-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","example":"{{fingerprint}}"}},{"name":"X-Soldo-Fingerprint-Signature","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint_signature}}","description":"[Advanced authentication](ref:advanced-authentication): Signature of the `X-Soldo-Fingerprint`.","example":"{{fingerprint_signature}}"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSubscription"}}}},"responses":{"200":{"description":"The returned resource is a `Subscription`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Subscription"}}}},"400":{"description":"Your request has missing arguments or is malformed."}},"security":[{"standardAuth":["subscription_write"]}],"x-soldo":{"fingerprint-order":"id, name, wallet_id, payment_frequency, token"}},"post":{"tags":["Subscriptions"],"summary":"Activate Subscription","description":"Endpoint to activate a specific `Subscription`.","operationId":"subscription-activate","parameters":[{"name":"subscriptionId","in":"path","required":true,"schema":{"type":"string","description":"The `Subscription` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}},{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Advanced authentication](ref:advanced-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","example":"{{fingerprint}}"}},{"name":"X-Soldo-Fingerprint-Signature","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint_signature}}","description":"[Advanced authentication](ref:advanced-authentication): Signature of the `X-Soldo-Fingerprint`.","example":"{{fingerprint_signature}}"}}],"responses":{"200":{"description":"The returned resource is an `Order`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Order"}}}},"400":{"description":"Your request has missing arguments or is malformed."}},"security":[{"standardAuth":["subscription_write"]}],"x-soldo":{"fingerprint-order":"id, token"}},"delete":{"tags":["Subscriptions"],"summary":"Delete Subscription","description":"Endpoint to delete a specific `Subscription`.","operationId":"subscription-delete","parameters":[{"name":"subscriptionId","in":"path","required":true,"schema":{"type":"string","description":"The `Subscription` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}}],"responses":{"204":{"description":"No content as result."},"400":{"description":"Your request has missing arguments or is malformed."}},"security":[{"standardAuth":["subscription_write"]}]}},"/business/v2/addresses":{"get":{"tags":["Addresses"],"summary":"Search Addresses","description":"Endpoint to search `Addresses`.","operationId":"address-search","parameters":[{"name":"userId","in":"query","description":"The `User` ID.","schema":{"type":"string","description":"The `User` ID.","example":"XMPL1234-000001"},"example":"XMPL1234-000001"},{"name":"category","in":"query","description":"The `User` CATEGORY.","schema":{"$ref":"#/components/schemas/AddressCategory"},"example":"COMPANY"},{"name":"p","in":"query","description":"It indicates the specific page to display (the counter starts from zero).","schema":{"type":"integer","format":"int32","default":0,"description":"It indicates the specific page to display (the counter starts from zero).","example":3},"example":3},{"name":"s","in":"query","description":"It indicates the number of items per page.","schema":{"type":"integer","format":"int32","default":0,"description":"It indicates the number of items per page.","example":25,"maximum":50},"example":25},{"name":"d","in":"query","description":"It indicates how the pages are ordered.","schema":{"$ref":"#/components/schemas/Direction"},"example":"DESC"},{"name":"props","in":"query","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.","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"}},"example":"creationTime"}],"responses":{"200":{"description":"The result is an array containing `Addresses`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Addresses"}}}},"400":{"description":"Your request has missing arguments or is malformed."}},"security":[{"standardAuth":["address_read"]}]},"post":{"tags":["Addresses"],"summary":"Add Address","description":"Endpoint to create an `Address`.","operationId":"address-add","parameters":[{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Advanced authentication](ref:advanced-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","example":"{{fingerprint}}"}},{"name":"X-Soldo-Fingerprint-Signature","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint_signature}}","description":"[Advanced authentication](ref:advanced-authentication): Signature of the `X-Soldo-Fingerprint`.","example":"{{fingerprint_signature}}"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAddress"}}}},"responses":{"200":{"description":"The returned resource is the single `Address` created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Address"}}}},"400":{"description":"Your request has missing arguments or is malformed."}},"security":[{"standardAuth":["address_write"]}],"x-soldo":{"fingerprint-order":"recipient, name, line1, line2, country, county, city, post_code, delivery_phone_number, default_shipping, cards_to_link, cards_to_unlink, user_id, token"}}},"/business/v2/autotags":{"get":{"tags":["Autotags"],"summary":"Search Autotags","description":"Endpoint to find `Autotags` using filtering parameters.","operationId":"autotag-search","parameters":[{"name":"name","in":"query","description":"The name of the `Autotag`.","schema":{"type":"string","description":"The name of the `Autotag`.","example":"AutotagRule"},"example":"AutotagRule"},{"name":"enabled","in":"query","description":"It determines whether the `Autotag` rule is enabled (if a rule is not enabled, it won't be executed).","schema":{"type":"boolean","description":"It determines whether the `Autotag` rule is enabled (if a rule is not enabled, it won't be executed).","example":true},"example":true},{"name":"ownerId","in":"query","description":"The ID of the `User` who created the `Autotag`.","schema":{"type":"string","description":"The ID of the `User` who created the `Autotag`.","example":"XMPL1234-000001"},"example":"XMPL1234-000001"},{"name":"p","in":"query","description":"It indicates the specific page to display (the counter starts from zero).","schema":{"type":"integer","format":"int32","default":0,"description":"It indicates the specific page to display (the counter starts from zero).","example":3},"example":3},{"name":"s","in":"query","description":"It indicates the number of items per page.","schema":{"type":"integer","format":"int32","default":0,"description":"It indicates the number of items per page.","example":25,"maximum":50},"example":25},{"name":"d","in":"query","description":"It indicates how the pages are ordered.","schema":{"$ref":"#/components/schemas/Direction"},"example":"DESC"},{"name":"props","in":"query","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.","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"}},"example":"creationTime"}],"responses":{"200":{"description":"The returned resource is an array of `Autotags`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Autotags"}}}}},"security":[{"standardAuth":["autotag_read"]}]},"post":{"tags":["Autotags"],"summary":"Add Autotag","description":"Endpoint to add a new `Autotag`.","operationId":"autotag-add","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAutotag"}}}},"responses":{"200":{"description":"The returned resource is a single `Autotag`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Autotag"}}}},"400":{"description":"Your request has missing arguments or is malformed."},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["autotag_write"]}]}},"/business/v2/business-trips":{"get":{"tags":["Business Trips"],"summary":"Search BusinessTrips","description":"Endpoint to find `BusinessTrips` using filtering parameters.","operationId":"business-trip-search","parameters":[{"name":"fromDate","in":"query","description":"The beginning of the period of the search `fromDate` included (i.e. greater than or equal to) (Formats: `yyyy-MM-dd`, `yyyy-MM-ddThh:mm:ss`, `yyyy-MM-ddThh:mm:ssZ`).","schema":{"$ref":"#/components/schemas/DateParam"},"example":"2020-04-06T12:48:40Z"},{"name":"toDate","in":"query","description":"The end of the period of the search `toDate` included (i.e. less than) (Formats: `yyyy-MM-dd`, `yyyy-MM-ddThh:mm:ss`, `yyyy-MM-ddThh:mm:ssZ`).","schema":{"$ref":"#/components/schemas/DateParam"},"example":"2020-05-07T12:48:40Z"},{"name":"status","in":"query","description":"The status of the `BusinessTrip`.","schema":{"type":"array","description":"The status of the `Purchase`.","items":{"$ref":"#/components/schemas/BusinessTripPurchaseStatus"}},"example":"ACTIVE"},{"name":"dateType","in":"query","description":"It determines the date to be considered for `fromDate` and `toDate` parameters.","schema":{"$ref":"#/components/schemas/SearchBusinessTripDateType"},"example":"COMPLETED_TIME"},{"name":"travellerUserId","in":"query","description":"The ID of the `User` that is travelling with the `BusinessTrip`.","schema":{"type":"array","description":"The ID of the `User` that is travelling with the `BusinessTrip`.","items":{"type":"string","description":"The ID of the `User` that is travelling with the `BusinessTrip`."}},"example":"XMPL1234-000001"},{"name":"text","in":"query","description":"A simple text to search in the `BusinessTrip` data.","schema":{"type":"string","description":"A simple text to search in the `BusinessTrip` data.","example":"something"},"example":"something"},{"name":"p","in":"query","description":"It indicates the specific page to display (the counter starts from zero).","schema":{"type":"integer","format":"int32","default":0,"description":"It indicates the specific page to display (the counter starts from zero).","example":3},"example":3},{"name":"s","in":"query","description":"It indicates the number of items per page.","schema":{"type":"integer","format":"int32","default":0,"description":"It indicates the number of items per page.","example":25,"maximum":50},"example":25},{"name":"d","in":"query","description":"It indicates how the pages are ordered.","schema":{"$ref":"#/components/schemas/Direction"},"example":"DESC"},{"name":"props","in":"query","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.","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"}},"example":"creationTime"}],"responses":{"200":{"description":"The result is an array containing `BusinessTrips`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessTrips"}}}},"400":{"description":"Your request has missing arguments or is malformed."}},"security":[{"standardAuth":["business_trip_read"]}]},"post":{"tags":["Business Trips"],"summary":"Add Business Trip","description":"Endpoint to add a new `BusinessTrip`.","operationId":"business-trip-add","parameters":[{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Advanced authentication](ref:advanced-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","example":"{{fingerprint}}"}},{"name":"X-Soldo-Fingerprint-Signature","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint_signature}}","description":"[Advanced authentication](ref:advanced-authentication): Signature of the `X-Soldo-Fingerprint`.","example":"{{fingerprint_signature}}"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBusinessTrip"}}}},"responses":{"200":{"description":"The returned resource is a single `BusinessTrip`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessTrip"}}}},"400":{"description":"Your request has missing arguments or is malformed."}},"security":[{"standardAuth":["business_trip_write"]}],"x-soldo":{"fingerprint-order":"request_timestamp, name, traveller_user_id, traveller_card_id, wallet_id, join(concat(expense_allocation.spend_period,expense_allocation.amount,expense_allocation.amount_currency)))"}}},"/business/v2/cards":{"get":{"tags":["Cards"],"summary":"Search Cards","description":"Endpoint to find `Cards` using filtering parameters.","operationId":"card-search","parameters":[{"name":"type","in":"query","description":"The type of a resource the `Card` is attached to.","schema":{"$ref":"#/components/schemas/CardAttachedResourceType"},"example":"wallet"},{"name":"id","in":"query","description":"The ID of the `type` resource (it's not applicable for `company` resource; it's not required for `employees`).","schema":{"type":"string","description":"The ID of the `type` resource (it's not applicable for `company` resource; it's not required for `employees`).","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},{"name":"customreferenceId","in":"query","description":"The custom reference ID of the `type` resource.","schema":{"type":"string","description":"The custom reference ID of the `type` resource.","example":"123456-user-1"},"example":"123456-user-1"},{"name":"status","in":"query","description":"One among the available `Card` statuses of a `Card`.","schema":{"$ref":"#/components/schemas/CardStatus"},"example":"Normal"},{"name":"groupId","in":"query","description":"The ID of the `Group` the `Card` is related to.","schema":{"type":"string","description":"The ID of the `Group` the `Card` is related to.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},{"name":"name","in":"query","description":"The name of the `Card`.","schema":{"type":"string","description":"The name of the `Card`.","example":"CardName"},"example":"CardName"},{"name":"label","in":"query","description":"The label of the `Card`.","schema":{"type":"string","description":"The label of the `Card`.","example":"CardLabel"},"example":"CardLabel"},{"name":"p","in":"query","description":"It indicates the specific page to display (the counter starts from zero).","schema":{"type":"integer","format":"int32","default":0,"description":"It indicates the specific page to display (the counter starts from zero).","example":3},"example":3},{"name":"s","in":"query","description":"It indicates the number of items per page.","schema":{"type":"integer","format":"int32","default":0,"description":"It indicates the number of items per page.","example":25,"maximum":50},"example":25},{"name":"d","in":"query","description":"It indicates how the pages are ordered.","schema":{"$ref":"#/components/schemas/Direction"},"example":"DESC"},{"name":"props","in":"query","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.","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"}},"example":"creationTime"}],"responses":{"200":{"description":"The result is an array containing `Cards`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Cards"}}}},"400":{"description":"Your request has missing arguments or is malformed."}},"security":[{"standardAuth":["card_read"]}]},"post":{"tags":["Cards"],"summary":"Add Card","description":"Endpoint to add a new `Card`. The created `Card` has the same currency of the `Wallet` it belongs to.","operationId":"card-add","parameters":[{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Advanced authentication](ref:advanced-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","example":"{{fingerprint}}"}},{"name":"X-Soldo-Fingerprint-Signature","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint_signature}}","description":"[Advanced authentication](ref:advanced-authentication): Signature of the `X-Soldo-Fingerprint`.","example":"{{fingerprint_signature}}"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddCardOrder"}}}},"responses":{"200":{"description":"The returned resource is a single `Order`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Order"}}}},"400":{"description":"Your request has missing arguments or is malformed."},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["card_write"]}],"x-soldo":{"fingerprint-order":"request_timestamp, owner_type, owner_public_id, wallet_id, address_id, vehicle_id, preset_id, token"}}},"/business/v2/contacts":{"get":{"tags":["Contacts"],"summary":"Search Contacts","description":"Endpoint to search `Contacts` using filtering parameters.","operationId":"contact-search","parameters":[{"name":"statuses","in":"query","description":"The status of the `Contact`.","schema":{"type":"array","description":"The status of the `Contact`.","items":{"$ref":"#/components/schemas/ContactStatus"},"uniqueItems":true},"example":"CREATED"},{"name":"name","in":"query","schema":{"type":"array","description":"The name of the `Contact`.","example":"John","items":{"type":"string","description":"The name of the `Contact`.","example":"John"},"uniqueItems":true}},{"name":"type","in":"query","description":"The type of the `Contact`.","schema":{"type":"array","description":"The type of the `Contact`.","items":{"$ref":"#/components/schemas/ContactType"},"uniqueItems":true},"example":"SUPPLIER"},{"name":"countries","in":"query","description":"The [ISO 3166-1 alpha-3](https://www.iso.org/obp/ui/#search/code/) countries of the `Contact`.","schema":{"type":"array","description":"The [ISO 3166-1 alpha-3](https://www.iso.org/obp/ui/#search/code/) countries of the `Contact`.","items":{"$ref":"#/components/schemas/ISO3166Country"},"uniqueItems":true},"example":"ITA"},{"name":"user","in":"query","schema":{"type":"array","description":"The ID of the `User` the bank details are assigned.","example":"XMPL1234-000001","items":{"type":"string","description":"The ID of the `User` the bank details are assigned.","example":"XMPL1234-000001"},"uniqueItems":true}},{"name":"p","in":"query","description":"It indicates the specific page to display (the counter starts from zero).","schema":{"type":"integer","format":"int32","default":0,"description":"It indicates the specific page to display (the counter starts from zero).","example":3},"example":3},{"name":"s","in":"query","description":"It indicates the number of items per page.","schema":{"type":"integer","format":"int32","default":0,"description":"It indicates the number of items per page.","example":25,"maximum":50},"example":25},{"name":"d","in":"query","description":"It indicates how the pages are ordered.","schema":{"$ref":"#/components/schemas/Direction"},"example":"DESC"},{"name":"props","in":"query","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.","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"}},"example":"creationTime"}],"responses":{"200":{"description":"The returned result is a list of `Contacts`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Contacts"}}}},"400":{"description":"Your request has missing arguments or is malformed."}},"security":[{"standardAuth":["contact_read"]}]},"post":{"tags":["Contacts"],"summary":"Add Contact","description":"Endpoint to add a new `Contact`.","operationId":"contact-add","parameters":[{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Advanced authentication](ref:advanced-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","example":"{{fingerprint}}"}},{"name":"X-Soldo-Fingerprint-Signature","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint_signature}}","description":"[Advanced authentication](ref:advanced-authentication): Signature of the `X-Soldo-Fingerprint`.","example":"{{fingerprint_signature}}"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateContact"}}}},"responses":{"200":{"description":"The returned resource is a single `Contact`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Contact"}}}},"400":{"description":"Your request has missing arguments or is malformed."}},"security":[{"standardAuth":["contact_write"]}],"x-soldo":{"fingerprint-order":"name, type, country, join(concat(account_info.type, account_info.identification)),userId, token"}}},"/business/v2/employees/out-of-office":{"get":{"tags":["Out of Office"],"summary":"Search Out of Office","description":"Endpoint to search `out_of_office` using filtering parameters.","operationId":"out-of-office-search","parameters":[{"name":"delegatorId","in":"query","schema":{"type":"array","description":"The ID of the person assigning the `out_of_office`.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7","items":{"type":"string","description":"The ID of the person assigning the `out_of_office`.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"uniqueItems":true}},{"name":"delegateId","in":"query","schema":{"type":"array","description":"The ID of the person covering for the delegator.","example":"33333333-a7ae-4222-aa54-091ff7f429a7","items":{"type":"string","description":"The ID of the person covering for the delegator.","example":"33333333-a7ae-4222-aa54-091ff7f429a7"},"uniqueItems":true}},{"name":"fromDate","in":"query","description":"Defines when the out_of_office entry starts. fromDate included. (i.e. greater than or equal to) (Format:`yyyy-MM-dd`).","schema":{"type":"string","description":"Defines when the out_of_office entry starts. fromDate included. (i.e. greater than or equal to) (Format:`yyyy-MM-dd`).","example":"2025-03-05"},"example":"2025-03-05"},{"name":"toDate","in":"query","description":"Defines when the out_of_office entry ends, toDate included. (i.e. less than) (Format:`yyyy-MM-ddThh:mm:ssZ`,represents a UTC timezone).","schema":{"type":"string","description":"Defines when the out_of_office entry ends, toDate included. (i.e. less than) (Format:`yyyy-MM-ddThh:mm:ssZ`,represents a UTC timezone).","example":"2025-03-07"},"example":"2025-03-07"},{"name":"status","in":"query","description":"The status of `out_of_office`.","schema":{"type":"array","description":"The status of `out_of_office`.","items":{"$ref":"#/components/schemas/DelegationStatus"},"uniqueItems":true},"example":"ACTIVE"},{"name":"feature","in":"query","description":"The features of `out_of_office`.","schema":{"type":"array","description":"The features of `out_of_office`.","items":{"$ref":"#/components/schemas/DelegationFeature"},"uniqueItems":true},"example":"EXPENSE_REVIEW"},{"name":"p","in":"query","description":"It indicates the specific page to display (the counter starts from zero).","schema":{"type":"integer","format":"int32","default":0,"description":"It indicates the specific page to display (the counter starts from zero).","example":3},"example":3},{"name":"s","in":"query","description":"It indicates the number of items per page.","schema":{"type":"integer","format":"int32","default":0,"description":"It indicates the number of items per page.","example":25,"maximum":50},"example":25},{"name":"d","in":"query","description":"It indicates how the pages are ordered.","schema":{"$ref":"#/components/schemas/Direction"},"example":"DESC"},{"name":"props","in":"query","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.","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"}},"example":"creationTime"}],"responses":{"200":{"description":"The result is an array containing `out_of_office`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OutOfOfficeDelegations"}}}},"400":{"description":"Your request has missing arguments or is malformed."}},"security":[{"standardAuth":["out_of_office_delegation_read"]}]},"post":{"tags":["Out of Office"],"summary":"Add Out of Office","description":"Endpoint to add an `out_of_office`.","operationId":"out-of-office-add","parameters":[{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Advanced authentication](ref:advanced-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","example":"{{fingerprint}}"}},{"name":"X-Soldo-Fingerprint-Signature","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint_signature}}","description":"[Advanced authentication](ref:advanced-authentication): Signature of the `X-Soldo-Fingerprint`.","example":"{{fingerprint_signature}}"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateOutOfOfficeDelegation"}}}},"responses":{"200":{"description":"The result is a single `out_of_office`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OutOfOfficeDelegation"}}}},"400":{"description":"Your request has missing arguments or is malformed."},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["out_of_office_delegation_write"]}],"x-soldo":{"fingerprint-order":"request_timestamp, from_date, to_date, delegator_id, delegate_id, feature, token"}}},"/business/v2/entities/expense-category":{"get":{"tags":["Accounting Classification"],"summary":"Search Expense Categories","description":"Endpoint to find `ExpenseCategories` using filtering parameters.","operationId":"expense-category-search","parameters":[{"name":"text","in":"query","description":"A simple text to search in the `ExpenseCategory` (`name` or `code`).","schema":{"type":"string","description":"A simple text to search in the `ExpenseCategory` (`name` or `code`).","example":"expense category"},"example":"expense category"},{"name":"enabled","in":"query","description":"It determines if `ExpenseCategory` is enabled.","schema":{"type":"boolean","description":"It determines if `ExpenseCategory` is enabled.","example":true},"example":true},{"name":"p","in":"query","description":"It indicates the specific page to display (the counter starts from zero).","schema":{"type":"integer","format":"int32","default":0,"description":"It indicates the specific page to display (the counter starts from zero).","example":3},"example":3},{"name":"s","in":"query","description":"It indicates the number of items per page.","schema":{"type":"integer","format":"int32","default":0,"description":"It indicates the number of items per page.","example":25,"maximum":50},"example":25},{"name":"d","in":"query","description":"It indicates how the pages are ordered.","schema":{"$ref":"#/components/schemas/Direction"},"example":"DESC"},{"name":"props","in":"query","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.","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"}},"example":"creationTime"}],"responses":{"200":{"description":"The result is an array containing `ExpenseCategories`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExpenseCategories"}}}},"400":{"description":"Your request has missing arguments or is malformed."}},"security":[{"standardAuth":["expense_category_read"]}]},"post":{"tags":["Expense Categories"],"summary":"Add Expense Category","description":"Endpoint to add a new `ExpenseCategory`.","operationId":"expense-category-add","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateExpenseCategory"}}}},"responses":{"200":{"description":"The result is an `ExpenseCategory`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExpenseCategory"}}}},"400":{"description":"Your request has missing arguments or is malformed."},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["expense_category_write"]}]}},"/business/v2/expense-review/processes":{"get":{"tags":["Expense Review Processes"],"summary":"Search Expense Review Processes","description":"Endpoint to search `ExpenseReviewProcesses`.","operationId":"expense-review-processes-search","parameters":[{"name":"status","in":"query","description":"The status of the `ExpenseReviewProcess`.","schema":{"type":"array","description":"The status of the `ExpenseReviewProcess`.","items":{"$ref":"#/components/schemas/ExpenseReviewProcessStatusSearch"}},"example":"ACTIVE"},{"name":"text","in":"query","description":"A simple text to search `ExpenseReviewProcess` by `name` or `description`.","schema":{"type":"string","description":"A simple text to search `ExpenseReviewProcess` by `name` or `description`.","example":"EXPENSE REVIEW PROCESS"},"example":"EXPENSE REVIEW PROCESS"},{"name":"p","in":"query","description":"0","schema":{"type":"integer","format":"int32","default":0,"description":"It indicates the specific page to display (the counter starts from zero).","example":3},"example":3},{"name":"s","in":"query","description":"It indicates the number of items per page.","schema":{"type":"integer","format":"int32","default":0,"description":"It indicates the number of items per page.","example":25,"maximum":50},"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 `ExpenseReviewProcesses`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExpenseReviewProcesses"}}}},"400":{"description":"Your request has missing arguments or is malformed."}},"security":[{"standardAuth":["expense_review_read"]}]},"post":{"tags":["Expense Review Processes"],"summary":"Add Expense Review Process","description":"Endpoint to add an `ExpenseReviewProcess`.","operationId":"expense-review-process-add","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateExpenseReviewProcess"}}}},"responses":{"200":{"description":"The result is a single `ExpenseReviewProcess`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExpenseReviewProcess"}}}},"400":{"description":"Your request has missing arguments or is malformed."},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["expense_review_write"]}]}},"/business/v2/expense-review/configuration":{"get":{"tags":["Expense Review Configuration"],"summary":"Get Expense Review Configuration","description":"Endpoint to get `ExpenseReview` configuration","operationId":"expense-review-configuration-get","responses":{"200":{"description":"The result is the configuration of `ExpenseReview` resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExpenseReviewConfiguration"}}}},"400":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["expense_review_read"]}]},"put":{"tags":["Expense Review Configuration"],"summary":"Update Expense Review Configuration","description":"Endpoint to update a specific `ExpenseReview` Configuration.","operationId":"expense-review-configuration-update","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateExpenseReviewConfiguration"}}}},"responses":{"200":{"description":"The returned resource is an `ExpenseReview` configuration.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExpenseReviewConfiguration"}}}},"400":{"description":"Your request has missing arguments or is malformed."}},"security":[{"standardAuth":["expense_review_write"]}]},"post":{"tags":["Expense Review Configuration"],"summary":"Add Expense Review Configuration","description":"Endpoint to add an `ExpenseReview` configuration.","operationId":"expense-review-configuration-add","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateExpenseReviewConfiguration"}}}},"responses":{"200":{"description":"The returned resource is a single `ExpenseReview` configuration.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExpenseReviewConfiguration"}}}},"400":{"description":"Your request has missing arguments or is malformed."}},"security":[{"standardAuth":["expense_review_write"]}]}},"/business/v2/groups":{"get":{"tags":["Groups"],"summary":"Search Groups","description":"Endpoint to search `Groups`","operationId":"group-search","parameters":[{"name":"customReferenceId","in":"query","description":"The `Group` reference in an external system.","schema":{"type":"string","description":"The `Group` reference in an external system.","example":"hr-division-0001"},"example":"hr-division-0001"},{"name":"type","in":"query","description":"The `Group`'s type.","schema":{"$ref":"#/components/schemas/GroupType"},"example":"DIVISION"},{"name":"name","in":"query","description":"The name of the `Group`.","schema":{"type":"string","description":"The name of the `Group`.","example":"HR"},"example":"HR"},{"name":"note","in":"query","description":"The note of the `Group`.","schema":{"type":"string","description":"The note of the `Group`.","example":"division"},"example":"division"},{"name":"text","in":"query","description":"A text contained in the name or note of the `Group`.","schema":{"type":"string","description":"A text contained in the name or note of the `Group`.","example":"HR"},"example":"HR"},{"name":"p","in":"query","description":"It indicates the specific page to display (the counter starts from zero).","schema":{"type":"integer","format":"int32","default":0,"description":"It indicates the specific page to display (the counter starts from zero).","example":3},"example":3},{"name":"s","in":"query","description":"It indicates the number of items per page.","schema":{"type":"integer","format":"int32","default":0,"description":"It indicates the number of items per page.","example":25,"maximum":50},"example":25},{"name":"d","in":"query","description":"It indicates how the pages are ordered.","schema":{"$ref":"#/components/schemas/Direction"},"example":"DESC"},{"name":"props","in":"query","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.","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"}},"example":"creationTime"}],"responses":{"200":{"description":"The result is an array containing `Group`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Groups"}}}},"400":{"description":"Your request has missing arguments or is malformed."}},"security":[{"standardAuth":["group_read"]}]},"post":{"tags":["Groups"],"summary":"Add Group","description":"Endpoint to add a new `Group`.","operationId":"group-add","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateGroup"}}}},"responses":{"200":{"description":"The returned resource is a single `Group`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Group"}}}},"400":{"description":"Your request has missing arguments or is malformed."}},"security":[{"standardAuth":["group_write"]}]}},"/business/v2/dictionaries":{"get":{"tags":["Lists"],"summary":"Search Lists","description":"Endpoint to search `Lists` using filtering parameters.","operationId":"list-search","parameters":[{"name":"visible","in":"query","schema":{"type":"boolean","description":"It determines whether the `List` is active.","example":true}},{"name":"text","in":"query","schema":{"type":"string","description":"A text to search in the `List` data (name).","example":"something"}},{"name":"p","in":"query","description":"It indicates the specific page to display (the counter starts from zero).","schema":{"type":"integer","format":"int32","default":0,"description":"It indicates the specific page to display (the counter starts from zero).","example":3},"example":3},{"name":"s","in":"query","description":"It indicates the number of items per page.","schema":{"type":"integer","format":"int32","default":0,"description":"It indicates the number of items per page.","example":25,"maximum":50},"example":25},{"name":"d","in":"query","description":"It indicates how the pages are ordered.","schema":{"$ref":"#/components/schemas/Direction"},"example":"DESC"},{"name":"props","in":"query","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.","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"}},"example":"creationTime"}],"responses":{"200":{"description":"The result is an array containing `Lists`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TagDictionaries"}}}}},"security":[{"standardAuth":["tag_read"]}]},"post":{"tags":["Lists"],"summary":"Add List","description":"Endpoint to add a new `List`.","operationId":"list-add","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"dictionary":{"type":"string","description":"The name of the `List`.","example":"CustomTransactionMetadata"},"uniqueSelectTag":{"type":"boolean","description":"It determines whether multiple `Tags` of the `List` can be selected.","example":true},"required":{"type":"boolean","description":"It determines required.","example":false},"roles":{"type":"array","description":"List of `Roles` to can view items in transaction details.","example":["7bf79328-a7ae-4222-aa54-091ff7f429a7","2d65bd5e-3fdf-4002-b166-bde7fb8863fa"],"items":{"type":"string","description":"List of `Roles` to can view items in transaction details.","example":"[\"7bf79328-a7ae-4222-aa54-091ff7f429a7\",\"2d65bd5e-3fdf-4002-b166-bde7fb8863fa\"]"}},"users":{"type":"array","description":"List of `User` IDs to can view items in transaction details..","example":["XMPL1234-000001","XMPL1234-000002","XMPL1234-000003"],"items":{"type":"string","description":"List of `User` IDs to can view items in transaction details..","example":"[\"XMPL1234-000001\",\"XMPL1234-000002\",\"XMPL1234-000003\"]"}}}}}}},"responses":{"200":{"description":"The returned resource is a single `List`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TagDictionary"}}}},"400":{"description":"Your request has missing arguments or is malformed."},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["tag_write"]}]}},"/business/v2/online-ads/{onlineAdId}/addAssignees":{"put":{"tags":["Online Ads"],"summary":"Add assignees to Online Ads","description":"Endpoint to add assignees to an `OnlineAd`.","operationId":"online-ads-assignees-add","parameters":[{"name":"onlineAdId","in":"path","required":true,"schema":{"type":"string","description":"The `OnlineAd` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}},{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Advanced authentication](ref:advanced-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","example":"{{fingerprint}}"}},{"name":"X-Soldo-Fingerprint-Signature","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint_signature}}","description":"[Advanced authentication](ref:advanced-authentication): Signature of the `X-Soldo-Fingerprint`.","example":"{{fingerprint_signature}}"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddAssignees"}}}},"responses":{"200":{"description":"The returned resource is a single `OnlineAd`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OnlineAds"}}}},"400":{"description":"Your request has missing arguments or is malformed."}},"security":[{"standardAuth":["online_ads_write"]}],"x-soldo":{"fingerprint-order":"id, token"}}},"/business/v2/purchases":{"get":{"tags":["Pre-approved Spend"],"summary":"Search Purchases","description":"Endpoint to find `Purchases` using filtering parameters.","operationId":"pre-approved-spend-search","parameters":[{"name":"fromDate","in":"query","description":"The beginning of the period of the search `fromDate` included (i.e. greater than or equal to) (Formats: `yyyy-MM-dd`, `yyyy-MM-ddThh:mm:ss`, `yyyy-MM-ddThh:mm:ssZ`).","schema":{"$ref":"#/components/schemas/DateParam"},"example":"2020-04-06T12:48:40Z"},{"name":"toDate","in":"query","description":"The end of the period of the search `toDate` included (i.e. less than) (Formats: `yyyy-MM-dd`, `yyyy-MM-ddThh:mm:ss`, `yyyy-MM-ddThh:mm:ssZ`).","schema":{"$ref":"#/components/schemas/DateParam"},"example":"2020-05-07T12:48:40Z"},{"name":"dateType","in":"query","description":"It determines the date to be considered for `fromDate` and `toDate` parameters.","schema":{"$ref":"#/components/schemas/SearchPurchaseDateType"},"example":"COMPLETED_TIME"},{"name":"status","in":"query","description":"The status of the `Purchase`.","schema":{"type":"array","description":"The status of the `Purchase`.","items":{"$ref":"#/components/schemas/PurchaseStatus"}},"example":"ACTIVE"},{"name":"text","in":"query","description":"A simple text to search in the `Purchase` data (`title`, `description`, `assignees`).","schema":{"type":"string","description":"A simple text to search in the `Purchase` data (`title`, `description`, `assignees`).","example":"something"},"example":"something"},{"name":"p","in":"query","description":"It indicates the specific page to display (the counter starts from zero).","schema":{"type":"integer","format":"int32","default":0,"description":"It indicates the specific page to display (the counter starts from zero).","example":3},"example":3},{"name":"s","in":"query","description":"It indicates the number of items per page.","schema":{"type":"integer","format":"int32","default":0,"description":"It indicates the number of items per page.","example":25,"maximum":50},"example":25},{"name":"d","in":"query","description":"It indicates how the pages are ordered.","schema":{"$ref":"#/components/schemas/Direction"},"example":"DESC"},{"name":"props","in":"query","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.","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"}},"example":"creationTime"}],"responses":{"200":{"description":"The result is an array containing `Purchases`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Purchases"}}}},"400":{"description":"Your request has missing arguments or is malformed."}},"security":[{"standardAuth":["purchase_read"]}]},"post":{"tags":["Pre-approved Spend"],"summary":"Add Purchase","description":"Endpoint to add a new `Purchase`.","operationId":"pre-approved-spend-add","parameters":[{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Advanced authentication](ref:advanced-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","example":"{{fingerprint}}"}},{"name":"X-Soldo-Fingerprint-Signature","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint_signature}}","description":"[Advanced authentication](ref:advanced-authentication): Signature of the `X-Soldo-Fingerprint`.","example":"{{fingerprint_signature}}"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePurchase"}}}},"responses":{"200":{"description":"The returned resource is a single `Purchase`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Purchase"}}}},"400":{"description":"Your request has missing arguments or is malformed."}},"security":[{"standardAuth":["purchase_write"]}],"x-soldo":{"fingerprint-order":"title, assignee_id, wallet_id, amount, description, max_tx_number, token"}}},"/business/v2/requests":{"get":{"tags":["Requests"],"summary":"Search Requests","description":"Endpoint to search `Requests`.","operationId":"request-search","parameters":[{"name":"status","in":"query","description":"The status of the `request`","schema":{"type":"array","items":{"$ref":"#/components/schemas/RequestStatus"}},"example":"APPROVED"},{"name":"paymentMethod","in":"query","description":"The payment method of the `request`","schema":{"$ref":"#/components/schemas/PaymentMethod"},"example":"Temporary card"},{"name":"text","in":"query","description":"A simple text to search in the `Request` (`name` or `description`).","schema":{"type":"string","description":"A simple text to search in the `Request` (`name` or `description`).","example":"something"},"example":"something"},{"name":"p","in":"query","description":"It indicates the specific page to display (the counter starts from zero).","schema":{"type":"integer","format":"int32","default":0,"description":"It indicates the specific page to display (the counter starts from zero).","example":3},"example":3},{"name":"s","in":"query","description":"It indicates the number of items per page.","schema":{"type":"integer","format":"int32","default":0,"description":"It indicates the number of items per page.","example":25,"maximum":50},"example":25},{"name":"d","in":"query","description":"It indicates how the pages are ordered.","schema":{"$ref":"#/components/schemas/Direction"},"example":"DESC"},{"name":"props","in":"query","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.","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"}},"example":"creationTime"}],"responses":{"200":{"description":"The result is an array containing `Requests`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Requests"}}}},"400":{"description":"Your request has missing arguments or is malformed."}},"security":[{"standardAuth":["request_read"]}]},"post":{"tags":["Requests"],"summary":"Add request","description":"Endpoint to create an `Request`. There are 3 types of request:GOODS_OR_SERVICES, FUNDS,TRIP.The creation of GOODS_OR_SERVICES requests does not currently support Bank Transfer as a payment method.","operationId":"request-add","parameters":[{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Advanced authentication](ref:advanced-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","example":"{{fingerprint}}"}},{"name":"X-Soldo-Fingerprint-Signature","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint_signature}}","description":"[Advanced authentication](ref:advanced-authentication): Signature of the `X-Soldo-Fingerprint`.","example":"{{fingerprint_signature}}"}}],"requestBody":{"description":"Create `Request` JSON parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateRequestPayload"}}}},"responses":{"200":{"description":"The returned resource is the single `Request` created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestPayload"},"examples":{"GoodOrServicesResponseExample":{"summary":"type GOODS_OR_SERVICES","description":"GoodOrServicesResponseExample","value":{"id":"776f5018-07e5-426b-a426-8b23fa1e985d","type":"GOODS_OR_SERVICES","name":"Goods or Services","amount":150,"currency":"EUR","status":"PENDING","request_process_id":"7bf79328-a7ae-4222-aa54-091ff7f429a7","number_transactions":"1","payment_method":"card","description":"TYPE GOOD_SERVICES","requester":"LVRS6404-000089","approveDate":"2025-12-03T14:19:36Z","hasAttachments":"false","note":"note","creation_time":"2025-12-03T14:15:14Z","last_update":"2025-12-03T14:19:36Z"}},"TripResponseExample":{"summary":"type TRIP","description":"TripResponseExample","value":{"id":"776f5018-07e5-426b-a426-8b23fa1e985d","type":"TRIP","name":"Trip","amount":"150.00","currency":"EUR","status":"PENDING","request_process_id":"7bf79328-a7ae-4222-aa54-091ff7f429a7","card_id":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa","description":"TYPE TRIP","requester":"LVRS6404-000089","approveDate":"2025-12-03T14:19:36Z","hasAttachments":"false","note":"note","destination":"Rome","date_from":"2025-12-24T23:00:00Z","date_to":"2025-12-26T22:59:59.999Z","traveller":"LVRS6404-000005","expense_allocation":[{"expense_category_id":"0145e140-fc56-4ffd-9a57-a3c776bb2b51","spend_period":"BEFORE_TRIP","amount":1,"amount_currency":"EUR"}],"tags":[],"creation_time":"2025-12-03T14:15:14Z","last_update":"2025-12-03T14:19:36Z"}},"FundResponseExample":{"summary":"type FUNDS","description":"FundResponseExample","value":{"id":"776f5018-07e5-426b-a426-8b23fa1e985d","type":"FUNDS","name":"Fund","amount":150,"currency":"EUR","status":"PENDING","request_process_id":"7bf79328-a7ae-4222-aa54-091ff7f429a7","card_id":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa","description":"TYPE FUNDS","requester":"LVRS6404-000089","approveDate":"2025-12-03T14:19:36Z","hasAttachments":"false","note":"note","creation_time":"2025-12-03T14:15:14Z","last_update":"2025-12-03T14:19:36Z"}}}}}},"400":{"description":"Your request has missing arguments or is malformed."}},"security":[{"standardAuth":["request_write"]}],"x-soldo":{"fingerprint-order":"request_timestamp, name, request_process_id, type, token"}}},"/business/v2/resource-sets":{"get":{"tags":["Resource Sets"],"summary":"Search Resource Sets","description":"Endpoint to search `ResourceSet` using filtering parameters.","operationId":"resource-set-search","parameters":[{"name":"text","in":"query","schema":{"type":"string","description":"A free text search in the `ResourceSet` data","example":"Resource set 01"}}],"responses":{"200":{"description":"The result is an array containing `ResourceSets`.","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ResourceSet"}}}}}},"security":[{"standardAuth":["resource_set_read"]}]},"post":{"tags":["Resource Sets"],"summary":"Add Resource Set","description":"Endpoint to add a new `ResourceSet`.","operationId":"resource-set-add","parameters":[{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Advanced authentication](ref:advanced-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","example":"{{fingerprint}}"}},{"name":"X-Soldo-Fingerprint-Signature","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint_signature}}","description":"[Advanced authentication](ref:advanced-authentication): Signature of the `X-Soldo-Fingerprint`.","example":"{{fingerprint_signature}}"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResourceSet"}}}},"responses":{"200":{"description":"The returned resource is a single `ResourceSet`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceSet"}}}},"400":{"description":"Your request has missing arguments or is malformed."}},"security":[{"standardAuth":["resource_set_write"]}],"x-soldo":{"fingerprint-order":"name, description, token"}}},"/business/v2/groups/{groupId}/resource":{"post":{"tags":["Groups"],"summary":"Add Resource To Group","description":"Endpoint to add a new resource to a Group.","operationId":"group-resource-add","parameters":[{"name":"groupId","in":"path","required":true,"schema":{"type":"string","description":"The `Group` ID.","example":"1bf79328-a7ae-4222-aa54-091ff7f429a7"}},{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Advanced authentication](ref:advanced-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","example":"{{fingerprint}}"}},{"name":"X-Soldo-Fingerprint-Signature","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint_signature}}","description":"[Advanced authentication](ref:advanced-authentication): Signature of the `X-Soldo-Fingerprint`.","example":"{{fingerprint_signature}}"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupResource"}}}},"responses":{"204":{"description":"No content as result."},"400":{"description":"Your request has missing arguments or is malformed."}},"security":[{"standardAuth":["group_write"]}],"x-soldo":{"fingerprint-order":"groupId, type, token"}},"delete":{"tags":["Groups"],"summary":"Remove resource from Group","description":"Endpoint to remove a resource from a `Group`.","operationId":"group-resource-remove","parameters":[{"name":"groupId","in":"path","required":true,"schema":{"type":"string","description":"The `Group` ID.","example":"1bf79328-a7ae-4222-aa54-091ff7f429a7"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupResource"}}}},"responses":{"204":{"description":"No content as result."},"400":{"description":"Your request has missing arguments or is malformed."}},"security":[{"standardAuth":["group_write"]}]}},"/business/v2/subscriptions/{subscriptionId}/addAssignees":{"put":{"tags":["Subscriptions"],"summary":"Add assignees to Subscription","description":"Endpoint to add assignees to a `Subscription`.","operationId":"subscription-assignees-add","parameters":[{"name":"subscriptionId","in":"path","required":true,"schema":{"type":"string","description":"The `Subscription` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}},{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Advanced authentication](ref:advanced-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","example":"{{fingerprint}}"}},{"name":"X-Soldo-Fingerprint-Signature","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint_signature}}","description":"[Advanced authentication](ref:advanced-authentication): Signature of the `X-Soldo-Fingerprint`.","example":"{{fingerprint_signature}}"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddAssignees"}}}},"responses":{"200":{"description":"The returned resource is a `Subscription`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Subscription"}}}},"400":{"description":"Your request has missing arguments or is malformed."}},"security":[{"standardAuth":["subscription_write"]}],"x-soldo":{"fingerprint-order":"id, token"}}},"/business/v2/dictionaries/{listId}/tags":{"get":{"tags":["Tags"],"summary":"Search Tags","description":"Endpoint to search `Tags` in a given `List` using filtering parameters.","operationId":"tag-search","parameters":[{"name":"listId","in":"path","required":true,"schema":{"type":"string","description":"The `List` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}},{"name":"visible","in":"query","schema":{"type":"boolean","description":"It determines whether the `Tag` is visible in the `Transaction` detail.","example":true}},{"name":"name","in":"query","schema":{"type":"string","description":"The name of the `Tag` to search.","example":"something"}},{"name":"code","in":"query","schema":{"type":"string","description":"The code of the `Tag` to search.","example":"something"}},{"name":"text","in":"query","schema":{"type":"string","description":"The text of the `Tag` to search by name or description.","example":"something"}},{"name":"p","in":"query","description":"It indicates the specific page to display (the counter starts from zero).","schema":{"type":"integer","format":"int32","default":0,"description":"It indicates the specific page to display (the counter starts from zero).","example":3},"example":3},{"name":"s","in":"query","description":"It indicates the number of items per page.","schema":{"type":"integer","format":"int32","default":0,"description":"It indicates the number of items per page.","example":25,"maximum":50},"example":25},{"name":"d","in":"query","description":"It indicates how the pages are ordered.","schema":{"$ref":"#/components/schemas/Direction"},"example":"DESC"},{"name":"props","in":"query","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.","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"}},"example":"creationTime"}],"responses":{"200":{"description":"The result is an array containing `Tags`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Tags"}}}},"400":{"description":"Your request has missing arguments or is malformed."},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["tag_read"]}]},"post":{"tags":["Tags"],"summary":"Add Tag to List","description":"Endpoint to add a `Tag` into a `List`.","operationId":"tag-add","parameters":[{"name":"listId","in":"path","description":"The `List` ID.","required":true,"schema":{"type":"string","description":"The `List` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"tag":{"type":"string","description":"The name of the `Tag`.","example":"tx-label"},"description":{"type":"string","description":"The description of the `Tag`. If needed to support special characters, provide the character encoding in the `Content-Type` header (e.g. `application/x-www-form-urlencoded ; charset=utf-8`).","example":"Label to mark transactions"},"code":{"type":"string","description":"The code of the `Tag`. If needed to support special characters, provide the character encoding in the `Content-Type` header (e.g. `application/x-www-form-urlencoded ; charset=utf-8`).","example":"CODE tag"}}}}}},"responses":{"200":{"description":"The returned resource is a single `Tag`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Tag"}}}},"400":{"description":"Your request has missing arguments or is malformed."},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["tag_write"]}]}},"/business/v2/dictionaries/{listId}/tags/bulk":{"put":{"tags":["Tags"],"summary":"Update Tag bulk","description":"Endpoint to update a `List` by modifying up to 1000 `Tag` IDs per request.","operationId":"tags-update-bulk","parameters":[{"name":"listId","in":"path","required":true,"schema":{"type":"string","description":"The `List` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateTagItem"}}}},"responses":{"200":{"description":"The returned resource is a list of `Tag`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TagItems"}}}},"400":{"description":"Your request has missing arguments or is malformed."},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["tag_write"]}]},"post":{"tags":["Tags"],"summary":"Add Tag bulk to List","description":"Endpoint to add a `List` by adding up to 1000 `Tag` IDs per request.","operationId":"tags-add-bulk","parameters":[{"name":"listId","in":"path","required":true,"schema":{"type":"string","description":"The `List` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewTagBulk"}}}},"responses":{"200":{"description":"The result is an array containing `Tags`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TagItems"}}}},"400":{"description":"Your request has missing arguments or is malformed."},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["tag_write"]}]}},"/business/v2/entities/tax-rate":{"get":{"tags":["VAT Rates"],"summary":"Search VAT Rates","description":"Endpoint to find `VatRate` using filtering parameters.","operationId":"vat-rate-search","parameters":[{"name":"text","in":"query","description":"A simple text to search in the Vat rate data (name, code).","schema":{"type":"string","description":"A simple text to search in the Vat rate data (name, code).","example":"something"},"example":"something"},{"name":"enabled","in":"query","description":"It determines if Vat rate is enabled.","schema":{"type":"boolean","description":"It determines if Vat rate is enabled.","example":true},"example":true},{"name":"p","in":"query","description":"It indicates the specific page to display (the counter starts from zero).","schema":{"type":"integer","format":"int32","default":0,"description":"It indicates the specific page to display (the counter starts from zero).","example":3},"example":3},{"name":"s","in":"query","description":"It indicates the number of items per page.","schema":{"type":"integer","format":"int32","default":0,"description":"It indicates the number of items per page.","example":25,"maximum":50},"example":25},{"name":"d","in":"query","description":"It indicates how the pages are ordered.","schema":{"$ref":"#/components/schemas/Direction"},"example":"DESC"},{"name":"props","in":"query","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.","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"}},"example":"creationTime"}],"responses":{"200":{"description":"The result is an array containing `VATRates`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VatRates"}}}},"400":{"description":"Your request has missing arguments or is malformed."}},"security":[{"standardAuth":["tax_rate_read"]}]},"post":{"tags":["VAT Rates"],"summary":"Add VAT Rate","description":"Endpoint to add a new `VatRate`.","operationId":"vat-rate-add","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateVatRate"}}}},"responses":{"200":{"description":"The result is an `VatRate`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VatRate"}}}},"400":{"description":"Your request has missing arguments or is malformed."}},"security":[{"standardAuth":["tax_rate_write"]}]}},"/business/v2/transactions/custom-exports/bulk-add":{"post":{"tags":["Transaction Custom Export"],"summary":"Add Bulk TransactionCustomExport","description":"Endpoint bulk to add a new `TransactionCustomExport`.","operationId":"transaction-export-add","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateTransactionCustomExport"}}}},"responses":{"200":{"description":"The result is an array containing `TransactionCustomExport`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportedCustomTransaction"}}}},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["transaction_write"]}]}},"/business/v2/transactions/{transactionId}/metadata/{metadataId}":{"get":{"tags":["Transaction Metadata"],"summary":"Get Transaction Metadata","description":"Endpoint to get the metadata of a `Transaction` by ID.","operationId":"transaction-metadata-get","parameters":[{"name":"transactionId","in":"path","required":true,"schema":{"type":"string","description":"The `Transaction` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}},{"name":"metadataId","in":"path","required":true,"schema":{"type":"string","description":"The ID related to the custom generated metadata of the `Transaction`.","example":"metadata_id"}}],"responses":{"200":{"description":"The returned resource is a generic JSON representing the metadata.","content":{"application/json":{"schema":{}}}},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["transaction_read"]}]},"put":{"tags":["Transaction Metadata"],"summary":"Update Transaction Metadata","description":"Endpoint to update metadata of a `Transaction`.","operationId":"transaction-metadata-update","parameters":[{"name":"transactionId","in":"path","required":true,"schema":{"type":"string","description":"The `Transaction` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}},{"name":"metadataId","in":"path","required":true,"schema":{"type":"string","description":"The ID related to the new custom generated metadata of the `Transaction`.","example":"metadata_id"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":{"description":"A generic JSON."},"description":"A generic JSON."}}}},"responses":{"204":{"description":"No content as result."},"400":{"description":"Your request has missing arguments or is malformed."},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["transaction_write"]}]},"post":{"tags":["Transaction Metadata"],"summary":"Add Transaction Metadata","description":"Endpoint to add metadata to a `Transaction`.","operationId":"transaction-metadata-add","parameters":[{"name":"transactionId","in":"path","required":true,"schema":{"type":"string","description":"The `transaction` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}},{"name":"metadataId","in":"path","required":true,"schema":{"type":"string","description":"The ID related to the new custom generated Metadata of the `Transaction`.","example":"metadata_id"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":{"description":"A generic JSON."},"description":"A generic JSON."}}}},"responses":{"204":{"description":"No content as result."},"400":{"description":"Your request has missing arguments or is malformed."},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["transaction_write"]}]},"delete":{"tags":["Transaction Metadata"],"summary":"Delete Transaction Metadata","description":"Endpoint to delete metadata of a `Transaction`.","operationId":"transaction-metadata-delete","parameters":[{"name":"transactionId","in":"path","required":true,"schema":{"type":"string","description":"The `Transaction` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}},{"name":"metadataId","in":"path","required":true,"schema":{"type":"string","description":"The ID related to the new custom generated metadata of the `Transaction`.","example":"metadata_id"}}],"responses":{"204":{"description":"No content as result."},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["transaction_write"]}]}},"/business/v2/transactions/{transactionId}/tags/{tagId}":{"post":{"tags":["Transaction Tags"],"summary":"Add Tag to Transaction","description":"Endpoint to assign a `Tag` to a `Transaction`.","operationId":"transaction-tag-add","parameters":[{"name":"transactionId","in":"path","required":true,"schema":{"type":"string","description":"The `Transaction` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}},{"name":"tagId","in":"path","required":true,"schema":{"type":"string","description":"The `Tag` ID.","example":"c861cc24-6663-410f-8c78-73f886fff4ef"}}],"responses":{"204":{"description":"No content as result."},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["transaction_write"]}]},"delete":{"tags":["Transaction Tags"],"summary":"Remove Tag from Transaction","description":"Endpoint to remove a `Tag` from a `Transaction`.","operationId":"transaction-tag-remove","parameters":[{"name":"transactionId","in":"path","required":true,"schema":{"type":"string","description":"The `Transaction` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}},{"name":"tagId","in":"path","required":true,"schema":{"type":"string","description":"The `Tag` ID.","example":"6853e657-c797-4985-8d6b-5425d4e51df8"}}],"responses":{"204":{"description":"No content as result."},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["transaction_write"]}]}},"/business/v2/vehicles":{"get":{"tags":["Vehicles"],"summary":"Search Vehicle","description":"Endpoint to find Vehicles using filtering parameters.","operationId":"vehicle-search","parameters":[{"name":"text","in":"query","description":"A text to be searched on the number plate and description field.","schema":{"type":"string","description":"A text to be searched on the number plate and description field.","example":"something"},"example":"something"},{"name":"ids","in":"query","description":"The IDs of the vehicles to search.","schema":{"type":"array","description":"The IDs of the vehicles to search.","example":"776f5018-07e5-426b-a426-8b23fa1e985d","items":{"type":"string","description":"The IDs of the vehicles to search.","example":"776f5018-07e5-426b-a426-8b23fa1e985d"}},"example":"776f5018-07e5-426b-a426-8b23fa1e985d"},{"name":"p","in":"query","description":"It indicates the specific page to display (the counter starts from zero).","schema":{"type":"integer","format":"int32","default":0,"description":"It indicates the specific page to display (the counter starts from zero).","example":3},"example":3},{"name":"s","in":"query","description":"It indicates the number of items per page.","schema":{"type":"integer","format":"int32","default":0,"description":"It indicates the number of items per page.","example":25,"maximum":50},"example":25},{"name":"d","in":"query","description":"It indicates how the pages are ordered.","schema":{"$ref":"#/components/schemas/Direction"},"example":"DESC"},{"name":"props","in":"query","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.","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"}},"example":"creationTime"}],"responses":{"200":{"description":"The returned array contains `Vehicle` resources.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Vehicles"}}}},"400":{"description":"Your request has missing arguments or is malformed."}},"security":[{"standardAuth":["vehicle_read"]}]},"post":{"tags":["Vehicles"],"summary":"Add Vehicle","description":"Endpoint to add a new `Vehicle`.","operationId":"vehicle-add","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateVehicle"}}}},"responses":{"200":{"description":"The returned resource is a new `Vehicle`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Vehicle"}}}},"400":{"description":"Your request has missing arguments or is malformed."}},"security":[{"standardAuth":["vehicle_write"]}]}},"/business/v2/wallets":{"get":{"tags":["Wallets"],"summary":"Search Wallets","description":"Endpoint to search `Wallets` using filtering parameters.","operationId":"wallet-search","parameters":[{"name":"type","in":"query","description":"The type of resource assigned to the `Wallet`.","schema":{"$ref":"#/components/schemas/PrimaryUserType"},"example":"company"},{"name":"id","in":"query","description":"The ID of the `type` resource.","schema":{"type":"string","description":"The ID of the `type` resource.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},{"name":"customreferenceId","in":"query","description":"The custom reference ID of the `type` resource.","schema":{"type":"string","description":"The custom reference ID of the `type` resource.","example":"123456-user-1"},"example":"123456-user-1"},{"name":"groupId","in":"query","description":"The ID of the `Group` the `Wallet` is related to.","schema":{"type":"string","description":"The ID of the `Group` the `Wallet` is related to.","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"},"example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"},{"name":"name","in":"query","description":"The full or partial name of the `Wallet`.","schema":{"type":"string","description":"The full or partial name of the `Wallet`.","example":"John Doe"},"example":"John Doe"},{"name":"p","in":"query","description":"It indicates the specific page to display (the counter starts from zero).","schema":{"type":"integer","format":"int32","default":0,"description":"It indicates the specific page to display (the counter starts from zero).","example":3},"example":3},{"name":"s","in":"query","description":"It indicates the number of items per page.","schema":{"type":"integer","format":"int32","default":0,"description":"It indicates the number of items per page.","example":25,"maximum":50},"example":25},{"name":"d","in":"query","description":"It indicates how the pages are ordered.","schema":{"$ref":"#/components/schemas/Direction"},"example":"DESC"},{"name":"props","in":"query","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.","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"}},"example":"creationTime"}],"responses":{"200":{"description":"The returned resource is an array containing `Wallets`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Wallets"}}}},"400":{"description":"Your request has missing arguments or is malformed."}},"security":[{"standardAuth":["wallet_read"]}]},"post":{"tags":["Wallets"],"summary":"Add Wallet","description":"Endpoint to add a new `Wallet`. Only company wallets can be created, a user dedicated wallet for each currency supported by your account is automatically created by the Soldo platform. *Deprecated*: use [/wallets/create](ref:wallet-create) instead.","operationId":"wallet-add","parameters":[{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Advanced authentication](ref:advanced-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","example":"{{fingerprint}}"}},{"name":"X-Soldo-Fingerprint-Signature","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint_signature}}","description":"[Advanced authentication](ref:advanced-authentication): Signature of the `X-Soldo-Fingerprint`.","example":"{{fingerprint_signature}}"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddWalletOrder"}}}},"responses":{"200":{"description":"The returned resource is a single `Order`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Order"}}}},"400":{"description":"Your request has missing arguments or is malformed."}},"deprecated":true,"security":[{"standardAuth":["wallet_write"]}],"x-soldo":{"fingerprint-order":"request_timestamp, owner_type, currency, name, token"}}},"/business/v2/wallets/autotransfer-presets/{presetId}/relate-resource":{"put":{"tags":["Auto-Transfer Presets"],"summary":"Add wallets to Auto-transfer Preset","description":"Endpoint to add a `Wallets` to `AutoTransferPreset`.","operationId":"wallet-auto-transfer-preset-set","parameters":[{"name":"presetId","in":"path","description":"The `AutoTransferPreset` ID","required":true,"schema":{"type":"string"},"example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"},{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Advanced authentication](ref:advanced-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","example":"{{fingerprint}}"}},{"name":"X-Soldo-Fingerprint-Signature","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint_signature}}","description":"[Advanced authentication](ref:advanced-authentication): Signature of the `X-Soldo-Fingerprint`.","example":"{{fingerprint_signature}}"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WalletsToTransfer"}}}},"responses":{"204":{"description":"No content as result."},"400":{"description":"Your request has missing arguments or is malformed."}},"security":[{"standardAuth":["wallet_write"]}],"x-soldo":{"fingerprint-order":"presetId, walletIds, token"}}},"/business/v2/webhooks/subscriptions":{"get":{"tags":["Webhook Subscriptions"],"summary":"Search Webhook Subscriptions","description":"Endpoint to search `WebhookSubscriptions` using filtering parameters.","operationId":"webhook-subscription-search","parameters":[{"name":"webhookUrl","in":"query","schema":{"type":"string","description":"The url of the `WebhookSubscription`.","example":"https://your_domain.com/xx/xx"}},{"name":"enabledEvents","in":"query","schema":{"type":"array","description":"The list of the enabled events of the search.","items":{"$ref":"#/components/schemas/WebhookEventName"}}},{"name":"active","in":"query","schema":{"type":"boolean","description":"The status of the webhook (if false, notifications are not sent)."}},{"name":"description","in":"query","schema":{"type":"string","description":"The description of the `WebhookSubscription`.","example":"Transactions and user webhook"}},{"name":"p","in":"query","description":"It indicates the specific page to display (the counter starts from zero).","schema":{"type":"integer","format":"int32","default":0,"description":"It indicates the specific page to display (the counter starts from zero).","example":3},"example":3},{"name":"s","in":"query","description":"It indicates the number of items per page.","schema":{"type":"integer","format":"int32","default":0,"description":"It indicates the number of items per page.","example":25,"maximum":50},"example":25},{"name":"d","in":"query","description":"It indicates how the pages are ordered.","schema":{"$ref":"#/components/schemas/Direction"},"example":"DESC"},{"name":"props","in":"query","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.","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"}},"example":"creationTime"}],"responses":{"200":{"description":"The result is an array containing `WebhookSubscriptions`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookSubscriptions"}}}},"400":{"description":"Your request has missing arguments or is malformed."}},"security":[{"standardAuth":["webhook_subscription_read"]}]},"post":{"tags":["Webhook Subscriptions"],"summary":"Add Webhook Subscription","description":"Endpoint to add a new `WebhookSubscription`.","operationId":"webhook-subscription-add","parameters":[{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Advanced authentication](ref:advanced-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","example":"{{fingerprint}}"}},{"name":"X-Soldo-Fingerprint-Signature","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint_signature}}","description":"[Advanced authentication](ref:advanced-authentication): Signature of the `X-Soldo-Fingerprint`.","example":"{{fingerprint_signature}}"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateWebhookSubscription"}}}},"responses":{"200":{"description":"The returned resource is a single `WebhookSubscription`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookSubscription"}}}},"400":{"description":"Your request has missing arguments or is malformed."}},"security":[{"standardAuth":["webhook_subscription_write"]}],"x-soldo":{"fingerprint-order":"webhook_url, enabled_events(joined), active, token"}}},"/business/v2/requests/{requestId}/approve":{"put":{"tags":["Requests"],"summary":"Approve Request","description":"Endpoint to approve an `Request` by ID. Payload depends on the request type (GOODS_OR_SERVICES, FUNDS, TRIP).The approval of GOODS_OR_SERVICES requests does not currently support Bank Transfer as a payment method.","operationId":"request-approve","parameters":[{"name":"requestId","in":"path","required":true,"schema":{"type":"string","description":"The `Request` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}}],"requestBody":{"description":"Approved `request` JSON parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApprovedRequestPayload"}}}},"responses":{"204":{"description":"No content as result."},"400":{"description":"Your request has missing arguments or is malformed."},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["request_write"]}]}},"/business/v2/employees/{userId}/assignRole":{"post":{"tags":["User Roles"],"summary":"Add roles to User","description":"Endpoint to assign a `Role` to an `User`.","operationId":"user-role-set","parameters":[{"name":"userId","in":"path","required":true,"schema":{"type":"string","description":"The `User` ID to assign `Role` to.","example":"XMPL1234-000001"}},{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Advanced authentication](ref:advanced-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","example":"{{fingerprint}}"}},{"name":"X-Soldo-Fingerprint-Signature","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint_signature}}","description":"[Advanced authentication](ref:advanced-authentication): Signature of the `X-Soldo-Fingerprint`.","example":"{{fingerprint_signature}}"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUserRoleAssignment"}}}},"responses":{"200":{"description":"The returned resource is a single `User`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssignedUserRoles"}}}},"400":{"description":"Your request has missing arguments or is malformed."}},"security":[{"standardAuth":["employee_write"]}],"x-soldo":{"fingerprint-order":"userId, name, description, scope, token"}}},"/business/v2/autotags/{autotagId}":{"get":{"tags":["Autotags"],"summary":"Get Autotag","description":"Endpoint to get a specific `Autotag` by ID.","operationId":"autotag-get","parameters":[{"name":"autotagId","in":"path","required":true,"schema":{"type":"string","description":"The `Autotag` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}}],"responses":{"200":{"description":"The returned resource is a single `Autotag`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Autotag"}}}},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["autotag_read"]}]},"put":{"tags":["Autotags"],"summary":"Update Autotag","description":"Endpoint to update the settings of a specific `Autotag`.","operationId":"autotag-update","parameters":[{"name":"autotagId","in":"path","required":true,"schema":{"type":"string","description":"The `Autotag` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAutotag"}}}},"responses":{"200":{"description":"The returned resource is a single `Autotag`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Autotag"}}}},"400":{"description":"Your request has missing arguments or is malformed."},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["autotag_write"]}]},"delete":{"tags":["Autotags"],"summary":"Delete Autotag","description":"Endpoint to delete a specific `Autotag`.","operationId":"autotag-delete","parameters":[{"name":"autotagId","in":"path","required":true,"schema":{"type":"string","description":"The `Autotag` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}}],"responses":{"204":{"description":"No content as result."},"400":{"description":"Your request has missing arguments or is malformed."}},"security":[{"standardAuth":["autotag_write"]}]}},"/business/v2/roles":{"get":{"tags":["Permissions"],"summary":"Get Roles","description":"Endpoint to retrieve all `User` `Roles`.","operationId":"roles-list","responses":{"200":{"description":"The result is an array of `UserRoles`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserRoles"}}}}},"security":[{"standardAuth":["role_read"]}]}},"/business/v2/business-trips/{businessTripId}":{"get":{"tags":["Business Trips"],"summary":"Get BusinessTrip","description":"Endpoint to get a specific `BusinessTrip` by ID.","operationId":"business-trip-get","parameters":[{"name":"businessTripId","in":"path","required":true,"schema":{"type":"string","description":"The `BusinessTrip` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}}],"responses":{"200":{"description":"The returned resource is a single `BusinessTrip`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessTrip"}}}},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["business_trip_read"]}]},"delete":{"tags":["Business Trips"],"summary":"Delete BusinessTrip","description":"Endpoint to delete a `BusinessTrip`.","operationId":"business-trip-delete","parameters":[{"name":"businessTripId","in":"path","required":true,"schema":{"type":"string","description":"The `BusinessTrip` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}}],"responses":{"204":{"description":"No content as result."},"400":{"description":"Your request has missing arguments or is malformed."},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["business_trip_write"]}]}},"/business/v2/cards/{cardId}":{"get":{"tags":["Cards"],"summary":"Get Card","description":"Endpoint to retrieve a specific `Card` by ID.","operationId":"card-get","parameters":[{"name":"cardId","in":"path","required":true,"schema":{"type":"string","description":"The `Card` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}},{"name":"showSensitiveData","in":"query","schema":{"type":"boolean","description":"It determines whether to show `Card` sensitive data."}}],"responses":{"200":{"description":"The returned resource is a single `Card`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Card"}}}},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["card_read"]}]},"put":{"tags":["Cards"],"summary":"Update Card","description":"Endpoint to add and remove assignees for company `Cards`.","operationId":"card-update","parameters":[{"name":"cardId","in":"path","required":true,"schema":{"type":"string","description":"The `Card` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}},{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Advanced authentication](ref:advanced-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","example":"{{fingerprint}}"}},{"name":"X-Soldo-Fingerprint-Signature","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint_signature}}","description":"[Advanced authentication](ref:advanced-authentication): Signature of the `X-Soldo-Fingerprint`.","example":"{{fingerprint_signature}}"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCard"}}}},"responses":{"200":{"description":"The returned resource is a single `Card`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Card"}}}},"400":{"description":"Your request has missing arguments or is malformed."},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["card_write"]}],"x-soldo":{"fingerprint-order":"cardId, join(addCardAssignees), join(removeCardAssignees), label, vehicle_id, token"}},"delete":{"tags":["Cards"],"summary":"Delete Card","description":"Endpoint to delete a `Card`.","operationId":"card-delete","parameters":[{"name":"cardId","in":"path","required":true,"schema":{"type":"string","description":"The `Card` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}}],"responses":{"204":{"description":"No content as result."},"400":{"description":"Your request has missing arguments or is malformed."},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["card_write"]}]}},"/business/v2/cards/{cardId}/rules/cashpoint":{"get":{"tags":["Card Rules"],"summary":"Get CashPoint Rules","description":"Endpoint to get the `CardRuleCashPointRules` of the `Card`.","operationId":"card-rule-cashpoint-get","parameters":[{"name":"cardId","in":"path","required":true,"schema":{"type":"string","description":"The `Card` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}}],"responses":{"200":{"description":"The result is a `CardRuleCashPointRules`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CardRuleCashPointRules"}}}},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["card_read"]}]}},"/business/v2/cards/{cardId}/rules/countries":{"get":{"tags":["Card Rules"],"summary":"Get Countries Rules","description":"Endpoint to get the `CardRuleCountries` of the `Card`.","operationId":"card-rule-countries-get","parameters":[{"name":"cardId","in":"path","required":true,"schema":{"type":"string","description":"The `Card` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}}],"responses":{"200":{"description":"The results is `CardRuleCountries`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CardRuleCountries"}}}},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["card_read"]}]},"post":{"tags":["Card Rules"],"summary":"Set Countries Rules","description":"Endpoint to set the `CardRuleCountries` of the `Card`.","operationId":"card-rule-countries-set","parameters":[{"name":"cardId","in":"path","required":true,"schema":{"type":"string","description":"The `Card` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}},{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Advanced authentication](ref:advanced-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","example":"{{fingerprint}}"}},{"name":"X-Soldo-Fingerprint-Signature","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint_signature}}","description":"[Advanced authentication](ref:advanced-authentication): Signature of the `X-Soldo-Fingerprint`.","example":"{{fingerprint_signature}}"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCardRuleCountries"}}}},"responses":{"200":{"description":"The results is `CardRuleCountries`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CardRuleCountries"}}}},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["card_write"]}],"x-soldo":{"fingerprint-order":"cardId, request_timestamp, token"}}},"/business/v2/cards/{cardId}/rules/merchantCategories":{"get":{"tags":["Card Rules"],"summary":"Get Merchant Categories Rules","description":"Endpoint to get the `CardRuleMerchantCategories` of the `Card`.","operationId":"card-rule-merchant-categories-get","parameters":[{"name":"cardId","in":"path","required":true,"schema":{"type":"string","description":"The `Card` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}}],"responses":{"200":{"description":"The result is a `CardRuleMerchantCategories`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CardRuleMerchantCategories"}}}},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["card_read"]}]},"post":{"tags":["Card Rules"],"summary":"Set Merchant Categories Rules","description":"Endpoint to set the `CardRuleMerchantCategories` of the `Card`.","operationId":"card-rule-merchant-categories-set","parameters":[{"name":"cardId","in":"path","required":true,"schema":{"type":"string","description":"The `Card` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}},{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Advanced authentication](ref:advanced-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","example":"{{fingerprint}}"}},{"name":"X-Soldo-Fingerprint-Signature","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint_signature}}","description":"[Advanced authentication](ref:advanced-authentication): Signature of the `X-Soldo-Fingerprint`.","example":"{{fingerprint_signature}}"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCardRuleMerchantCategories"}}}},"responses":{"200":{"description":"The result is a `CardRuleMerchantCategories`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CardRuleMerchantCategories"}}}},"400":{"description":"Your request has missing arguments or is malformed."},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["card_write"]}],"x-soldo":{"fingerprint-order":"cardId, request_timestamp, token"}}},"/business/v2/cards/{cardId}/rules/spendingLimits":{"get":{"tags":["Card Rules"],"summary":"Get Spending Limits Rules","description":"Endpoint to get the `CardRuleSpendingLimitsRules` of the `Card`.","operationId":"card-rule-spending-limits-get","parameters":[{"name":"cardId","in":"path","required":true,"schema":{"type":"string","description":"The `Card` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}}],"responses":{"200":{"description":"The result is a `CardRuleSpendingLimitsRules`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CardRuleSpendingLimitsRules"}}}},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["card_read"]}]}},"/business/v2/cards/{cardId}/move/{newWalletId}":{"put":{"tags":["Cards"],"summary":"Switch Card Wallet","description":"Endpoint to switch the `Card` `Wallet`.","operationId":"card-wallet-switch","parameters":[{"name":"cardId","in":"path","required":true,"schema":{"type":"string","description":"The `Card` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}},{"name":"newWalletId","in":"path","required":true,"schema":{"type":"string","description":"The new `Wallet` ID.","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"}},{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Advanced authentication](ref:advanced-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","example":"{{fingerprint}}"}},{"name":"X-Soldo-Fingerprint-Signature","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint_signature}}","description":"[Advanced authentication](ref:advanced-authentication): Signature of the `X-Soldo-Fingerprint`.","example":"{{fingerprint_signature}}"}}],"responses":{"200":{"description":"The returned resource is a single `Card`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Card"}}}},"400":{"description":"Your request has missing arguments or is malformed."},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["card_write","wallet_write"]}],"x-soldo":{"fingerprint-order":"cardId, newWalletId, token"}}},"/business/v2/expense-review/processes/priority":{"post":{"tags":["Expense Review Processes"],"summary":"Change Expense Review Processes Priority","description":"Endpoint to change the `ExpenseReviewProcess` order of priority.","operationId":"expense-review-process-priority-change","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExpenseReviewProcessPriority"}}}},"responses":{"204":{"description":"No content as result."},"400":{"description":"Your request has missing arguments or is malformed."},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["expense_review_write"]}]}},"/business/v2/company":{"get":{"tags":["Company"],"summary":"Get Company","description":"Endpoint to retrieve one's own `Company` info.","operationId":"company-get","responses":{"200":{"description":"The returned resource is one's own `Company`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Company"}}}}},"security":[{"standardAuth":["company_read"]}]}},"/business/v2/business-trips/{businessTripId}/complete-transfer":{"post":{"tags":["Business Trips"],"summary":"Complete Business Trip Transfer","description":"Endpoint to complete the funds transfer for a `BusinessTrip`.","operationId":"business-trip-complete-transfer","parameters":[{"name":"businessTripId","in":"path","required":true,"schema":{"type":"string","description":"The `BusinessTrip` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}},{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Advanced authentication](ref:advanced-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","example":"{{fingerprint}}"}},{"name":"X-Soldo-Fingerprint-Signature","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint_signature}}","description":"[Advanced authentication](ref:advanced-authentication): Signature of the `X-Soldo-Fingerprint`.","example":"{{fingerprint_signature}}"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompleteBusinessTripTransfer"}}}},"responses":{"204":{"description":"No content as result."},"400":{"description":"Your request has missing arguments or is malformed."},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["business_trip_write"]}],"x-soldo":{"fingerprint-order":"request_timestamp, id"}}},"/business/v2/transactions/{transactionId}/attachments/{attachmentId}":{"get":{"tags":["Transaction Attachments"],"summary":"Get Transaction Attachment","description":"Endpoint to get a specific `TransactionAttachment` by ID.","operationId":"transaction-attachment-get","parameters":[{"name":"transactionId","in":"path","required":true,"schema":{"type":"string","description":"The `Transaction` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}},{"name":"attachmentId","in":"path","required":true,"schema":{"type":"string","description":"The `TransactionAttachment` ID.","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"}}],"responses":{"200":{"description":"The returned resource is a single `TransactionAttachment`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionAttachment"}}}},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["transaction_read"]}]},"put":{"tags":["Transaction Attachments"],"summary":"Update Transaction Attachment Metadata","description":"Endpoint to update the `TransactionAttachment` Metadata of by ID.","operationId":"transaction-attachment-metadata-update","parameters":[{"name":"transactionId","in":"path","required":true,"schema":{"type":"string","description":"The `Transaction` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}},{"name":"attachmentId","in":"path","required":true,"schema":{"type":"string","description":"The `TransactionAttachment` ID.","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateTransactionAttachment"}}}},"responses":{"200":{"description":"The returned resource is a single `TransactionAttachment`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionAttachment"}}}},"400":{"description":"Your request has missing arguments or is malformed."},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["transaction_write"]}]},"post":{"tags":["Transaction Attachments"],"summary":"Confirm Transaction Attachment Upload","description":"After you got the temporary file URL of type `UPLOAD_URL` and the attachment file is uploaded, the upload of the `TransactionAttachment` must be confirmed.","operationId":"transaction-attachment-upload-confirm","parameters":[{"name":"transactionId","in":"path","required":true,"schema":{"type":"string","description":"The `Transaction` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}},{"name":"attachmentId","in":"path","required":true,"schema":{"type":"string","description":"The `TransactionAttachment` ID.","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"fileName":{"type":"string","description":"The file name of the attachment.","example":"invoice87.jpg"},"fileType":{"type":"string","description":"The file type of the attachment.","example":"PDF"}}}}}},"responses":{"200":{"description":"The returned resource is a single `TransactionAttachment`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionAttachment"}}}},"400":{"description":"Your request has missing arguments or is malformed."},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["transaction_write"]}]},"delete":{"tags":["Transaction Attachments"],"summary":"Delete Transaction Attachment","description":"Endpoint to delete a `TransactionAttachment` by ID.","operationId":"transaction-attachment-delete","parameters":[{"name":"transactionId","in":"path","required":true,"schema":{"type":"string","description":"The `Transaction` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}},{"name":"attachmentId","in":"path","required":true,"schema":{"type":"string","description":"The `TransactionAttachment` ID.","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"}}],"responses":{"204":{"description":"No content as result."}},"security":[{"standardAuth":["transaction_write"]}]}},"/business/v2/contacts/{contactId}":{"get":{"tags":["Contacts"],"summary":"Get Contact","description":"Endpoint to get specific `Contact` by ID.","operationId":"contact-get","parameters":[{"name":"contactId","in":"path","required":true,"schema":{"type":"string","description":"The `Contact` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}}],"responses":{"200":{"description":"The returned resource is a single `Contact`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Contact"}}}},"400":{"description":"Your request has missing arguments or is malformed."}},"security":[{"standardAuth":["contact_write"]}]},"put":{"tags":["Contacts"],"summary":"Update Contact","description":"Endpoint to update `Contact`.","operationId":"contact-update","parameters":[{"name":"contactId","in":"path","required":true,"schema":{"type":"string","description":"The `Contact` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}},{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Advanced authentication](ref:advanced-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","example":"{{fingerprint}}"}},{"name":"X-Soldo-Fingerprint-Signature","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint_signature}}","description":"[Advanced authentication](ref:advanced-authentication): Signature of the `X-Soldo-Fingerprint`.","example":"{{fingerprint_signature}}"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateContact"}}}},"responses":{"200":{"description":"The returned resource is a single `Contact`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Contact"}}}},"400":{"description":"Your request has missing arguments or is malformed."},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["contact_write"]}],"x-soldo":{"fingerprint-order":"contactId, type, join(concat(account_info.type, account_info.identification)),userId, token"}},"delete":{"tags":["Contacts"],"summary":"Delete Contact","description":"Endpoint to delete a specific `Contact`.","operationId":"contact-delete","parameters":[{"name":"contactId","in":"path","required":true,"schema":{"type":"string","description":"The `Contact` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}}],"responses":{"204":{"description":"No content as result."},"400":{"description":"Your request has missing arguments or is malformed."}},"security":[{"standardAuth":["contact_write"]}]}},"/business/v2/employees/create":{"post":{"tags":["Users"],"summary":"Create User","description":"Endpoint to create a new `User`.","operationId":"user-create","parameters":[{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Advanced authentication](ref:advanced-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","example":"{{fingerprint}}"}},{"name":"X-Soldo-Fingerprint-Signature","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint_signature}}","description":"[Advanced authentication](ref:advanced-authentication): Signature of the `X-Soldo-Fingerprint`.","example":"{{fingerprint_signature}}"}}],"requestBody":{"description":"Create employee JSON Parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateUser"}}},"required":true},"responses":{"200":{"description":"The returned result is an `User`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}},"400":{"description":"Your request has missing arguments or is malformed."}},"security":[{"standardAuth":["employee_write"]}],"x-soldo":{"fingerprint-order":"request_timestamp, name, surname, mobile_access, web_access, token"}}},"/business/v2/transactions/mileage-reimbursements":{"post":{"tags":["Transactions"],"summary":"Create Mileage Reimbursement Transaction","description":"Endpoint to create a `MileageReimbursement` `Transaction`.","operationId":"mileage-reimbursement-transaction-create","parameters":[{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Advanced authentication](ref:advanced-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","example":"{{fingerprint}}"}},{"name":"X-Soldo-Fingerprint-Signature","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint_signature}}","description":"[Advanced authentication](ref:advanced-authentication): Signature of the `X-Soldo-Fingerprint`.","example":"{{fingerprint_signature}}"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateMileageReimbursementTransaction"}}}},"responses":{"200":{"description":"The returned resource is a single `MileageReimbursement`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MileageReimbursementTransaction"}}}},"400":{"description":"Your request has missing arguments or is malformed."},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["transaction_write"]}],"x-soldo":{"fingerprint-order":"request_timestamp, date, owner_id, mileage.vehicle_id, mileage.reimbursement_rate, mileage.distance, mileage.round_trip, token"}}},"/business/v2/online-ads":{"get":{"tags":["Online Ads"],"summary":"Search Online Ads","description":"Endpoint to search `OnlineAds` using filtering parameters.","operationId":"online-ads-search","parameters":[{"name":"text","in":"query","description":"A simple text to search in the `OnlineAds` data (name, description, assignee name).","schema":{"type":"string","description":"A simple text to search in the `OnlineAds` data (name, description, assignee name).","example":"onlinename"},"example":"onlinename"},{"name":"platforms","in":"query","description":"The `OnlineAds` platform.","schema":{"type":"array","description":"The `OnlineAds` platform.","items":{"$ref":"#/components/schemas/OnlineAdsPlatform"},"uniqueItems":true},"example":"GOOGLE"},{"name":"assignees","in":"query","schema":{"type":"array","description":"The `OnlineAds` assignees.","example":"776f5018-07e5-426b-a426-8b23fa1e985d","items":{"type":"string","description":"The `OnlineAds` assignees.","example":"776f5018-07e5-426b-a426-8b23fa1e985d"},"uniqueItems":true}},{"name":"statuses","in":"query","description":"The Online Ad status.","schema":{"type":"array","description":"The Online Ad status.","items":{"$ref":"#/components/schemas/OnlineAdsStatus"},"uniqueItems":true},"example":"ACTIVE"},{"name":"p","in":"query","description":"It indicates the specific page to display (the counter starts from zero).","schema":{"type":"integer","format":"int32","default":0,"description":"It indicates the specific page to display (the counter starts from zero).","example":3},"example":3},{"name":"s","in":"query","description":"It indicates the number of items per page.","schema":{"type":"integer","format":"int32","default":0,"description":"It indicates the number of items per page.","example":25,"maximum":50},"example":25},{"name":"d","in":"query","description":"It indicates how the pages are ordered.","schema":{"$ref":"#/components/schemas/Direction"},"example":"DESC"},{"name":"props","in":"query","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.","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"}},"example":"creationTime"}],"responses":{"200":{"description":"The result is an array containing `OnlineAds`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OnlineAdsList"}}}},"400":{"description":"Your request has missing arguments or is malformed."}},"security":[{"standardAuth":["online_ads_read"]}]},"post":{"tags":["Online Ads"],"summary":"Add Online Ads","description":"Endpoint to add a new `OnlineAd`.","operationId":"online-ads-add","parameters":[{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Advanced authentication](ref:advanced-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","example":"{{fingerprint}}"}},{"name":"X-Soldo-Fingerprint-Signature","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint_signature}}","description":"[Advanced authentication](ref:advanced-authentication): Signature of the `X-Soldo-Fingerprint`.","example":"{{fingerprint_signature}}"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateOnlineAds"}}}},"responses":{"200":{"description":"The result is an `OnlineAd`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OnlineAdsList"}}}},"400":{"description":"Your request has missing arguments or is malformed."}},"security":[{"standardAuth":["online_ads_write"]}],"x-soldo":{"fingerprint-order":"name, platform, wallet_id, token"}}},"/business/v2/transactions/out-of-platform-transactions":{"post":{"tags":["Transactions"],"summary":"Create Out-Of-Platform Transaction","description":"Endpoint to create an Out-Of-Platform `Transaction` (not automatically tracked by Soldo).","operationId":"out-of-platform-transaction-create","parameters":[{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Advanced authentication](ref:advanced-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","example":"{{fingerprint}}"}},{"name":"X-Soldo-Fingerprint-Signature","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint_signature}}","description":"[Advanced authentication](ref:advanced-authentication): Signature of the `X-Soldo-Fingerprint`.","example":"{{fingerprint_signature}}"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateOutOfPlatformTransaction"}}}},"responses":{"200":{"description":"The returned resource is a single Out-Of-Platform `Transaction`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OutOfPlatformTransaction"}}}},"400":{"description":"Your request has missing arguments or is malformed."},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["transaction_write"]}],"x-soldo":{"fingerprint-order":"request_timestamp, date, owner_id, merchant_name, tx_amount, tx_amount_currency, exchange_rate, payment_method, token"}}},"/business/v2/subscriptions":{"get":{"tags":["Subscriptions"],"summary":"Search Subscriptions","description":"Endpoint to find `Subscriptions` using filtering parameters.","operationId":"subscription-search","parameters":[{"name":"text","in":"query","description":"A simple text to search in the Subscription data (name, description, assignee name).","schema":{"type":"string","description":"A simple text to search in the Subscription data (name, description, assignee name).","example":"something"},"example":"something"},{"name":"assignees","in":"query","schema":{"type":"array","description":"The `Subscription` assignees.","example":"776f5018-07e5-426b-a426-8b23fa1e985d","items":{"type":"string","description":"The `Subscription` assignees.","example":"776f5018-07e5-426b-a426-8b23fa1e985d"}}},{"name":"statuses","in":"query","description":"The `Subscription` status.","schema":{"type":"array","description":"The `Subscription` status.","items":{"$ref":"#/components/schemas/SubscriptionStatus"},"uniqueItems":true},"example":"ACTIVE"},{"name":"p","in":"query","description":"It indicates the specific page to display (the counter starts from zero).","schema":{"type":"integer","format":"int32","default":0,"description":"It indicates the specific page to display (the counter starts from zero).","example":3},"example":3},{"name":"s","in":"query","description":"It indicates the number of items per page.","schema":{"type":"integer","format":"int32","default":0,"description":"It indicates the number of items per page.","example":25,"maximum":50},"example":25},{"name":"d","in":"query","description":"It indicates how the pages are ordered.","schema":{"$ref":"#/components/schemas/Direction"},"example":"DESC"},{"name":"props","in":"query","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.","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"}},"example":"creationTime"}],"responses":{"200":{"description":"The returned result is an array containing `Subscriptions`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Subscriptions"}}}},"400":{"description":"Your request has missing arguments or is malformed."}},"security":[{"standardAuth":["subscription_read"]}]},"post":{"tags":["Subscriptions"],"summary":"Add Subscription","description":"Endpoint to add a new `Subscription`.","operationId":"subscription-add","parameters":[{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Advanced authentication](ref:advanced-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","example":"{{fingerprint}}"}},{"name":"X-Soldo-Fingerprint-Signature","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint_signature}}","description":"[Advanced authentication](ref:advanced-authentication): Signature of the `X-Soldo-Fingerprint`.","example":"{{fingerprint_signature}}"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSubscription"}}}},"responses":{"200":{"description":"The returned resource is a `Subscription`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Subscription"}}}},"400":{"description":"Your request has missing arguments or is malformed."}},"security":[{"standardAuth":["subscription_write"]}],"x-soldo":{"fingerprint-order":"name, platform, wallet_id, payment_frequency, token"}}},"/business/v2/transactions/{transactionId}/split":{"put":{"tags":["Transaction Split"],"summary":"Update Transaction Split","description":"Endpoint to update the split of a `Transaction`.","operationId":"transaction-split-update","parameters":[{"name":"transactionId","in":"path","required":true,"schema":{"type":"string","description":"The `Transaction` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateTransactionSplit"}}}},"responses":{"204":{"description":"No content as result."}},"security":[{"standardAuth":["transaction_write"]}]},"post":{"tags":["Transaction Split"],"summary":"Create Transaction Split","description":"Endpoint to split a `Transaction`.","operationId":"transaction-split-create","parameters":[{"name":"transactionId","in":"path","required":true,"schema":{"type":"string","description":"The `Transaction` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateTransactionSplit"}}}},"responses":{"204":{"description":"No content as result."}},"security":[{"standardAuth":["transaction_write"]}]},"delete":{"tags":["Transaction Split"],"summary":"Delete Transaction Split","description":"Endpoint to delete the split of a `Transaction`.","operationId":"transaction-split-delete","parameters":[{"name":"transactionId","in":"path","required":true,"schema":{"type":"string","description":"The `Transaction` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}}],"responses":{"204":{"description":"No content as result."}},"security":[{"standardAuth":["transaction_write"]}]}},"/business/v2/wallets/create":{"post":{"tags":["Wallets"],"summary":"Create Wallet","description":"Endpoint to add a new `Wallet`. Only company wallets can be created, a user dedicated wallet for each currency supported by your account is automatically created by the Soldo platform.","operationId":"wallet-create","requestBody":{"description":"Create `Wallet` JSON Parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateWallet"}}},"required":true},"responses":{"200":{"description":"The returned resource is a `Wallet`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Wallet"}}}},"400":{"description":"Your request has missing arguments or is malformed."}},"security":[{"standardAuth":["wallet_write"]}]}},"/business/v2/requests/{requestId}/decline":{"put":{"tags":["Requests"],"summary":"Decline Request","description":"Endpoint to decline an `Request` by ID.The decline of GOODS_OR_SERVICES requests does not currently support Bank Transfer as a payment method.","operationId":"request-decline","parameters":[{"name":"requestId","in":"path","required":true,"schema":{"type":"string","description":"The `Request` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}}],"requestBody":{"description":"Decline `request` JSON parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeclineRequest"}}}},"responses":{"204":{"description":"No content as result."},"400":{"description":"Your request has missing arguments or is malformed."},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["request_write"]}]}},"/business/v2/employees/out-of-office/{out_of_office_id}":{"get":{"tags":["Out of Office"],"summary":"Get Out of Office","description":"Endpoint to get a specific `out_of_office` by ID.","operationId":"out-of-office-get","parameters":[{"name":"out_of_office_id","in":"path","required":true,"schema":{"type":"string","description":"The `out_of_office` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}}],"responses":{"200":{"description":"The result is a single `out_of_office`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OutOfOfficeDelegation"}}}},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["out_of_office_delegation_read"]}]},"put":{"tags":["Out of Office"],"summary":"Update Out of Office","description":"Endpoint to update a specific `out_of_office`.","operationId":"out-of-office-update","parameters":[{"name":"out_of_office_id","in":"path","required":true,"schema":{"type":"string","description":"The `out_of_office` ID .","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}},{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Advanced authentication](ref:advanced-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","example":"{{fingerprint}}"}},{"name":"X-Soldo-Fingerprint-Signature","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint_signature}}","description":"[Advanced authentication](ref:advanced-authentication): Signature of the `X-Soldo-Fingerprint`.","example":"{{fingerprint_signature}}"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateOutOfOfficeDelegation"}}}},"responses":{"200":{"description":"The returned resource is a single `out_of_office`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OutOfOfficeDelegation"}}}},"400":{"description":"Your request has missing arguments or is malformed."},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["out_of_office_delegation_write"]}],"x-soldo":{"fingerprint-order":"id, request_timestamp, from_date, to_date, delegate_id, feature, token"}},"delete":{"tags":["Out of Office"],"summary":"Delete Out of Office","description":"Endpoint to delete a specific `out_of_office`.","operationId":"out-of-office-delete","parameters":[{"name":"out_of_office_id","in":"path","required":true,"schema":{"type":"string","description":"The `out_of_office` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}}],"responses":{"204":{"description":"No content as result."},"400":{"description":"Your request has missing arguments or is malformed."}},"security":[{"standardAuth":["out_of_office_delegation_write"]}]}},"/business/v2/addresses/{addressId}":{"get":{"tags":["Addresses"],"summary":"Get Address","description":"Endpoint to get an `Address` by ID.","operationId":"address-get","parameters":[{"name":"addressId","in":"path","required":true,"schema":{"type":"string","description":"The `Address` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}}],"responses":{"200":{"description":"The returned resource is a single `Address`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Address"}}}},"400":{"description":"Your request has missing arguments or is malformed."}},"security":[{"standardAuth":["address_read"]}]},"put":{"tags":["Addresses"],"summary":"Update Address","description":"Endpoint to update an `Address` by ID.","operationId":"address-update","parameters":[{"name":"addressId","in":"path","required":true,"schema":{"type":"string","description":"The `Address` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}},{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Advanced authentication](ref:advanced-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","example":"{{fingerprint}}"}},{"name":"X-Soldo-Fingerprint-Signature","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint_signature}}","description":"[Advanced authentication](ref:advanced-authentication): Signature of the `X-Soldo-Fingerprint`.","example":"{{fingerprint_signature}}"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAddress"}}}},"responses":{"200":{"description":"The returned resource is a single `Address`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Address"}}}},"400":{"description":"Your request has missing arguments or is malformed."},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["address_write"]}],"x-soldo":{"fingerprint-order":"addressId, recipient, name,line1, line2, country, county, city, post_code, delivery_phone_number, default_shipping, cards_to_link, cards_to_unlink, token"}},"delete":{"tags":["Addresses"],"summary":"Delete Address","description":"Endpoint to remove an `Address`.","operationId":"address-delete","parameters":[{"name":"addressId","in":"path","required":true,"schema":{"type":"string","description":"The `Address` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}}],"responses":{"204":{"description":"No content as result."},"400":{"description":"Your request has missing arguments or is malformed."}},"security":[{"standardAuth":["address_write"]}]}},"/business/v2/cards/{cardId}/rules/cashpoint/{limitName}":{"post":{"tags":["Card Rules"],"summary":"Set CashPoint Rules","description":"Endpoint to set a `CardRuleCashPointRule` of the `Card`.","operationId":"card-rule-cashpoint-set","parameters":[{"name":"cardId","in":"path","required":true,"schema":{"type":"string","description":"The `Card` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}},{"name":"limitName","in":"path","required":true,"schema":{"$ref":"#/components/schemas/CardRuleCashPointLimitName"}},{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Advanced authentication](ref:advanced-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","example":"{{fingerprint}}"}},{"name":"X-Soldo-Fingerprint-Signature","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint_signature}}","description":"[Advanced authentication](ref:advanced-authentication): Signature of the `X-Soldo-Fingerprint`.","example":"{{fingerprint_signature}}"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCardRuleCashPoint"}}}},"responses":{"200":{"description":"The result is a `CardRuleCashPointRules`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CardRuleCashPointRule"}}}},"400":{"description":"Your request has missing arguments or is malformed."},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["card_write"]}],"x-soldo":{"fingerprint-order":"max, enabled, token"}},"delete":{"tags":["Card Rules"],"summary":"Unset CashPoint Rules","description":"Endpoint to unset a `CardRuleCashPointRule` of the `Card`.","operationId":"card-rule-cashpoint-unset","parameters":[{"name":"cardId","in":"path","required":true,"schema":{"type":"string","description":"The `Card` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}},{"name":"limitName","in":"path","required":true,"schema":{"$ref":"#/components/schemas/CardRuleCashPointLimitName"}},{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Advanced authentication](ref:advanced-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","example":"{{fingerprint}}"}},{"name":"X-Soldo-Fingerprint-Signature","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint_signature}}","description":"[Advanced authentication](ref:advanced-authentication): Signature of the `X-Soldo-Fingerprint`.","example":"{{fingerprint_signature}}"}}],"responses":{"200":{"description":"The result is a single `CardRuleCashPointRule`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CardRuleCashPointRule"}}}},"400":{"description":"Your request has missing arguments or is malformed."},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["card_write"]}],"x-soldo":{"fingerprint-order":"cardId, limitName, token"}}},"/business/v2/cards/presets/{presetId}":{"get":{"tags":["Card Rules Presets"],"summary":"Get Preset","description":"Endpoint to get a `CardRulePreset` by ID.","operationId":"card-rule-preset-get","parameters":[{"name":"presetId","in":"path","description":"The `CardRulePreset` ID","required":true,"schema":{"type":"string"},"example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"}],"responses":{"200":{"description":"The returned resource is a `CardRulePreset`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CardRulePreset"}}}},"400":{"description":"Your request has missing arguments or is malformed."},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["card_read"]}]},"delete":{"tags":["Card Rules Presets"],"summary":"Delete Preset","description":"Endpoint to delete a `CardRulePreset` by ID.","operationId":"card-rule-preset-delete","parameters":[{"name":"presetId","in":"path","description":"The `CardRulePreset` ID.","required":true,"schema":{"type":"string"},"example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"}],"responses":{"204":{"description":"No content as result."},"400":{"description":"Your request has missing arguments or is malformed."},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["card_write"]}]}},"/business/v2/cards/{cardId}/rules/spendingLimits/{limitName}":{"post":{"tags":["Card Rules"],"summary":"Set Spending Limits Rules","description":"Endpoint to set the `CardRuleSpendingLimitsRules` of the `Card`.","operationId":"card-rule-spending-limits-set","parameters":[{"name":"cardId","in":"path","required":true,"schema":{"type":"string","description":"The `Card` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}},{"name":"limitName","in":"path","required":true,"schema":{"$ref":"#/components/schemas/CardRuleSpendingLimitsLimitName"}},{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Advanced authentication](ref:advanced-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","example":"{{fingerprint}}"}},{"name":"X-Soldo-Fingerprint-Signature","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint_signature}}","description":"[Advanced authentication](ref:advanced-authentication): Signature of the `X-Soldo-Fingerprint`.","example":"{{fingerprint_signature}}"}}],"requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/UpdateCardRuleSpendingLimit"}}}},"responses":{"200":{"description":"The result is a single `CardRuleSpendingLimitsRule`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CardRuleSpendingLimitsRule"}}}},"400":{"description":"Your request has missing arguments or is malformed."},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["card_write"]}],"x-soldo":{"fingerprint-order":"max, enabled, token"}},"delete":{"tags":["Card Rules"],"summary":"Unset Spending Limits Rules","description":"Endpoint to unset the `CardRuleSpendingLimitsRule`  of the `Card`.","operationId":"card-rule-spending-limits-unset","parameters":[{"name":"cardId","in":"path","required":true,"schema":{"type":"string","description":"The `Card` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}},{"name":"limitName","in":"path","required":true,"schema":{"$ref":"#/components/schemas/CardRuleSpendingLimitsLimitName"}},{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Advanced authentication](ref:advanced-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","example":"{{fingerprint}}"}},{"name":"X-Soldo-Fingerprint-Signature","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint_signature}}","description":"[Advanced authentication](ref:advanced-authentication): Signature of the `X-Soldo-Fingerprint`.","example":"{{fingerprint_signature}}"}}],"responses":{"200":{"description":"The result is a single `CardRuleSpendingLimitsRule`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CardRuleSpendingLimitsRule"}}}},"400":{"description":"Your request has missing arguments or is malformed."},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["card_read"]}],"x-soldo":{"fingerprint-order":"cardId, limitName, token"}}},"/business/v2/employees/{userId}":{"get":{"tags":["Users"],"summary":"Get User","description":"Endpoint to retrieve a specific `User` by ID.","operationId":"user-get","parameters":[{"name":"userId","in":"path","required":true,"schema":{"type":"string","description":"The `User` ID.","example":"XMPL1234-000001"}}],"responses":{"200":{"description":"The returned resource is a single `User`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["employee_read"]}]},"put":{"tags":["Users"],"summary":"Update User","description":"Endpoint to update an `User`.","operationId":"user-update","parameters":[{"name":"userId","in":"path","required":true,"schema":{"type":"string","description":"The `User` ID.","example":"XMPL1234-000001"}},{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Advanced authentication](ref:advanced-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","example":"{{fingerprint}}"}},{"name":"X-Soldo-Fingerprint-Signature","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint_signature}}","description":"[Advanced authentication](ref:advanced-authentication): Signature of the `X-Soldo-Fingerprint`.","example":"{{fingerprint_signature}}"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUser"}}}},"responses":{"200":{"description":"The returned result is a single `User`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}},"400":{"description":"Your request has missing arguments or is malformed."},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["employee_write"]}],"x-soldo":{"fingerprint-order":"custom_reference_id, job_title, mobile_number, mobile_prefix, email, enable_mobile_credential, enable_web_credential, token"}},"delete":{"tags":["Users"],"summary":"Delete User","description":"Endpoint to delete an `User`.","operationId":"user-delete","parameters":[{"name":"userId","in":"path","required":true,"schema":{"type":"string","description":"The `User` ID.","example":"XMPL1234-000001"}}],"responses":{"204":{"description":"No content as result."},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["employee_write"]}]}},"/business/v2/entities/expense-category/{expenseCategoryId}":{"get":{"tags":["Expense Categories"],"summary":"Get Expense Category","description":"Endpoint to get a specific `ExpenseCategory` by ID.","operationId":"expense-category-get","parameters":[{"name":"expenseCategoryId","in":"path","required":true,"schema":{"type":"string","description":"The `ExpenseCategory` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}}],"responses":{"200":{"description":"The result is a single `ExpenseCategory`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExpenseCategory"}}}},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["expense_category_read"]}]},"put":{"tags":["Expense Categories"],"summary":"Update Expense Category","description":"Endpoint to update a specific `ExpenseCategory`.","operationId":"expense-category-update","parameters":[{"name":"expenseCategoryId","in":"path","required":true,"schema":{"type":"string","description":"The `ExpenseCategory` ID.","example":"6853e657-c797-4985-8d6b-5425d4e51df8"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateExpenseCategory"}}}},"responses":{"200":{"description":"The returned resource is a single `ExpenseCategory`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExpenseCategory"}}}},"400":{"description":"Your request has missing arguments or is malformed."},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["expense_category_write"]}]},"delete":{"tags":["Expense Categories"],"summary":"Delete Expense Category","description":"Endpoint to delete a specific `ExpenseCategory`.","operationId":"expense-category-delete","parameters":[{"name":"expenseCategoryId","in":"path","required":true,"schema":{"type":"string","description":"The `ExpenseCategory` ID.","example":"6853e657-c797-4985-8d6b-5425d4e51df8"}}],"responses":{"204":{"description":"No content as result."},"400":{"description":"Your request has missing arguments or is malformed."}},"security":[{"standardAuth":["expense_category_write"]}]}},"/business/v2/expense-reports/{expenseReportId}":{"get":{"tags":["Expense Reports"],"summary":"Get Expense Report","description":"Endpoint to get a specific  `ExpenseReport` by ID.","operationId":"expense-report-get","parameters":[{"name":"expenseReportId","in":"path","required":true,"schema":{"type":"string","description":"The `ExpenseReport` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}}],"responses":{"200":{"description":"The result is a single  `ExpenseReport`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExpenseReport"}}}},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["expense_report_read"]}]},"put":{"tags":["Expense Reports"],"summary":"Update Expense Report","description":"Endpoint to update a specific `ExpenseReport`.","operationId":"expense-report-update","parameters":[{"name":"expenseReportId","in":"path","required":true,"schema":{"type":"string","description":"The `ExpenseReport` ID .","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateExpenseReport"}}}},"responses":{"200":{"description":"The returned resource is a single `ExpenseReport`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExpenseReport"}}}},"400":{"description":"Your request has missing arguments or is malformed."}},"security":[{"standardAuth":["expense_report_write"]}]},"delete":{"tags":["Expense Reports"],"summary":"Delete Expense Report","description":"Endpoint to delete a specific `ExpenseReport`.","operationId":"expense-report-delete","parameters":[{"name":"expenseReportId","in":"path","required":true,"schema":{"type":"string","description":"The `ExpenseReport` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}}],"responses":{"204":{"description":"No content as result."},"400":{"description":"Your request has missing arguments or is malformed."}},"security":[{"standardAuth":["expense_report_write"]}]}},"/business/v2/expense-review/processes/{processId}":{"get":{"tags":["Expense Review Processes"],"summary":"Get Expense Review Process","description":"Endpoint to get the `ExpenseReviewProcess`.","operationId":"expense-review-process-get","parameters":[{"name":"processId","in":"path","required":true,"schema":{"type":"string","description":"The `ExpenseReviewProcess` ID.","example":" 2d9f6514-4004-4122-b7f2-dcf7e034741c"}}],"responses":{"200":{"description":"The result is a single `ExpenseReviewProcess`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExpenseReviewProcess"}}}},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["expense_review_read"]}]},"put":{"tags":["Expense Review Processes"],"summary":"Update Expense Review Process","description":"Be aware that any change made on the steps of an `ExpenseReviewProcess` configuration is not applied to already existing transactions. If you need to apply the changes to already existing transactions, you can use the [Recalculate Expense Review Processes](ref:expense-review-process-recalculate) endpoint. Also, the object returned upon update might have a different ID.","operationId":"expense-review-process-update","parameters":[{"name":"processId","in":"path","required":true,"schema":{"type":"string","description":"The `ExpenseReviewProcess` ID.","example":" 2d9f6514-4004-4122-b7f2-dcf7e034741c"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateExpenseReviewProcess"}}}},"responses":{"200":{"description":"The result is a single `ExpenseReviewProcess`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExpenseReviewProcess"}}}},"400":{"description":"Your request has missing arguments or is malformed."},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["expense_review_write"]}]},"delete":{"tags":["Expense Review Processes"],"summary":"Delete Expense Review Process","description":"Endpoint to delete a `ExpenseReviewProcess`.","operationId":"expense-review-process-delete","parameters":[{"name":"processId","in":"path","required":true,"schema":{"type":"string","description":"The `ExpenseReviewProcess` 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":["expense_review_write"]}]}},"/business/v2/groups/{groupId}":{"get":{"tags":["Groups"],"summary":"Get Group","description":"Endpoint to get an `Group` by ID.","operationId":"group-get","parameters":[{"name":"groupId","in":"path","required":true,"schema":{"type":"string","description":"The `Group` ID.","example":"1bf79328-a7ae-4222-aa54-091ff7f429a7"}}],"responses":{"200":{"description":"The returned resource is a single `Group`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Group"}}}},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["group_read"]}]},"put":{"tags":["Groups"],"summary":"Update Group","description":"Endpoint to update an `Group` by ID.","operationId":"group-update","parameters":[{"name":"groupId","in":"path","required":true,"schema":{"type":"string","description":"The `Group` ID.","example":"1bf79328-a7ae-4222-aa54-091ff7f429a7"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateGroup"}}}},"responses":{"200":{"description":"The returned resource is a single `Group`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Group"}}}},"400":{"description":"Your request has missing arguments or is malformed."}},"security":[{"standardAuth":["group_write"]}]},"delete":{"tags":["Groups"],"summary":"Delete Group","description":"Endpoint to remove an `Group`.","operationId":"group-delete","parameters":[{"name":"groupId","in":"path","required":true,"schema":{"type":"string","description":"The `Group` ID.","example":"1bf79328-a7ae-4222-aa54-091ff7f429a7"}}],"responses":{"204":{"description":"No content as result."},"400":{"description":"Your request has missing arguments or is malformed."}},"security":[{"standardAuth":["group_write"]}]}},"/business/v2/dictionaries/{listId}":{"get":{"tags":["Lists"],"summary":"Get List","description":"Endpoint to get a specific `List` by ID.","operationId":"list-get","parameters":[{"name":"listId","in":"path","required":true,"schema":{"type":"string","description":"The `List` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}}],"responses":{"200":{"description":"The returned resource is a single `List`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TagDictionary"}}}},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["tag_read"]}]},"put":{"tags":["Lists"],"summary":"Update List","description":"Endpoint to update the configuration of a `List`.","operationId":"list-update","parameters":[{"name":"listId","in":"path","required":true,"schema":{"type":"string","description":"The `List` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"dictionary":{"type":"string","description":"The name of the `List`.","example":"ExampleTagDictionary"},"uniqueSelectTag":{"type":"boolean","description":"It determines whether multiple `Tags` of the `List` can be selected.","example":false},"required":{"type":"boolean","deprecated":true,"description":"It determines whether it's required or not.","example":false},"visible":{"type":"boolean","description":"It determines whether the `List` is active.","example":true},"roles":{"type":"array","description":"List of `Roles` to can view items in transaction details.","example":["7bf79328-a7ae-4222-aa54-091ff7f429a7","2d65bd5e-3fdf-4002-b166-bde7fb8863fa"],"items":{"type":"string","description":"List of `Roles` to can view items in transaction details.","example":"[\"7bf79328-a7ae-4222-aa54-091ff7f429a7\",\"2d65bd5e-3fdf-4002-b166-bde7fb8863fa\"]"}},"users":{"type":"array","description":"List of `User` IDs to can view items in transaction details..","example":["XMPL1234-000001","XMPL1234-000002","XMPL1234-000003"],"items":{"type":"string","description":"List of `User` IDs to can view items in transaction details..","example":"[\"XMPL1234-000001\",\"XMPL1234-000002\",\"XMPL1234-000003\"]"}}}}}}},"responses":{"200":{"description":"The returned resource is a single `List`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TagDictionary"}}}},"400":{"description":"Your request has missing arguments or is malformed."},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["tag_write"]}]},"delete":{"tags":["Lists"],"summary":"Delete List","description":"Endpoint to delete a `List`.","operationId":"list-delete","parameters":[{"name":"listId","in":"path","required":true,"schema":{"type":"string","description":"The `List` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}}],"responses":{"204":{"description":"No content as result."},"400":{"description":"Your request has missing arguments or is malformed."},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["tag_write"]}]}},"/business/v2/transactions/mileage-reimbursements/{transactionId}":{"get":{"tags":["Transactions"],"summary":"Get Mileage Reimbursement Transaction","description":"Endpoint to get a specific `MileageReimbursement` `Transaction`.","operationId":"mileage-reimbursement-transaction-get","parameters":[{"name":"transactionId","in":"path","required":true,"schema":{"type":"string","description":"The `Transaction` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}},{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Advanced authentication](ref:advanced-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","example":"{{fingerprint}}"}},{"name":"X-Soldo-Fingerprint-Signature","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint_signature}}","description":"[Advanced authentication](ref:advanced-authentication): Signature of the `X-Soldo-Fingerprint`.","example":"{{fingerprint_signature}}"}}],"responses":{"200":{"description":"The returned resource is a single `MileageReimbursement`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MileageReimbursementTransaction"}}}},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["transaction_read"]}],"x-soldo":{"fingerprint-order":"transactionId, token"}},"put":{"tags":["Transactions"],"summary":"Update Mileage Reimbursement Transaction","description":"Endpoint to update a `MileageReimbursement` `Transaction`. The entire resource representation must be included in the request body.","operationId":"mileage-reimbursement-transaction-update","parameters":[{"name":"transactionId","in":"path","required":true,"schema":{"type":"string","description":"The `Transaction` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}},{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Advanced authentication](ref:advanced-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","example":"{{fingerprint}}"}},{"name":"X-Soldo-Fingerprint-Signature","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint_signature}}","description":"[Advanced authentication](ref:advanced-authentication): Signature of the `X-Soldo-Fingerprint`.","example":"{{fingerprint_signature}}"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMileageReimbursementTransaction"}}}},"responses":{"200":{"description":"The returned resource is a single `MileageReimbursement`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MileageReimbursementTransaction"}}}},"400":{"description":"Your request has missing arguments or is malformed."},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["transaction_write"]}],"x-soldo":{"fingerprint-order":"transactionId, request_timestamp, date, mileage.vehicle_id, mileage.reimbursement_rate, mileage.distance, mileage.round_trip, token"}},"delete":{"tags":["Transactions"],"summary":"Delete Mileage Reimbursement Transaction","description":"Endpoint to delete a specific `MileageReimbursement` `Transaction`.","operationId":"mileage-reimbursement-transaction-delete","parameters":[{"name":"transactionId","in":"path","required":true,"schema":{"type":"string","description":"The `Transaction` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}},{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Advanced authentication](ref:advanced-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","example":"{{fingerprint}}"}},{"name":"X-Soldo-Fingerprint-Signature","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint_signature}}","description":"[Advanced authentication](ref:advanced-authentication): Signature of the `X-Soldo-Fingerprint`.","example":"{{fingerprint_signature}}"}}],"responses":{"204":{"description":"No content as result."}},"security":[{"standardAuth":["transaction_write"]}],"x-soldo":{"fingerprint-order":"transactionId, token"}}},"/business/v2/orders/{orderId}":{"get":{"tags":["Orders"],"summary":"Get Order","description":"Endpoint to retrieve a specific `Order`.","operationId":"order-get","parameters":[{"name":"orderId","in":"path","required":true,"schema":{"type":"string","description":"The `Order` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}}],"responses":{"200":{"description":"The returned resource is a single `Order`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Order"}}}},"400":{"description":"Your request has missing arguments or is malformed."}},"security":[{"standardAuth":["order_read"]}]},"delete":{"tags":["Orders"],"summary":"Delete Order","description":"Endpoint to delete a specific `Order`. Only resource in ERROR or PLACED status can be deleted.","operationId":"order-delete","parameters":[{"name":"orderId","in":"path","required":true,"schema":{"type":"string","description":"The `Order` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}}],"responses":{"204":{"description":"No content as result."},"400":{"description":"Your request has missing arguments or is malformed."}},"security":[{"standardAuth":["company_write"]}]}},"/business/v2/transactions/out-of-platform-transactions/{transactionId}":{"get":{"tags":["Transactions"],"summary":"Get Out-Of-Platform Transaction","description":"Endpoint to get a specific Out-Of-Platform `Transaction`.","operationId":"out-of-platform-transaction-get","parameters":[{"name":"transactionId","in":"path","required":true,"schema":{"type":"string","description":"The `Transaction` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}},{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Advanced authentication](ref:advanced-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","example":"{{fingerprint}}"}},{"name":"X-Soldo-Fingerprint-Signature","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint_signature}}","description":"[Advanced authentication](ref:advanced-authentication): Signature of the `X-Soldo-Fingerprint`.","example":"{{fingerprint_signature}}"}}],"responses":{"200":{"description":"The returned resource is a single Out-Of-Platform `Transaction`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OutOfPlatformTransaction"}}}},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["transaction_read"]}],"x-soldo":{"fingerprint-order":"transactionId, token"}},"put":{"tags":["Transactions"],"summary":"Update Out-Of-Platform Transaction","description":"Endpoint to update an Out-Of-Platform `Transaction`. The entire resource representation must be included in the request body.","operationId":"out-of-platform-transaction-update","parameters":[{"name":"transactionId","in":"path","required":true,"schema":{"type":"string","description":"The `Transaction` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}},{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Advanced authentication](ref:advanced-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","example":"{{fingerprint}}"}},{"name":"X-Soldo-Fingerprint-Signature","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint_signature}}","description":"[Advanced authentication](ref:advanced-authentication): Signature of the `X-Soldo-Fingerprint`.","example":"{{fingerprint_signature}}"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateOutOfPlatformTransaction"}}}},"responses":{"200":{"description":"The returned resource is a single Out-Of-Platform `Transaction`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OutOfPlatformTransaction"}}}},"400":{"description":"Your request has missing arguments or is malformed."},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["transaction_write"]}],"x-soldo":{"fingerprint-order":"transactionId, request_timestamp, date, merchant_name, tx_amount, tx_amount_currency, exchange_rate, payment_method, token"}},"delete":{"tags":["Transactions"],"summary":"Delete Out-Of-Platform Transaction","description":"Endpoint to delete a specific Out-Of-Platform `Transaction`.","operationId":"out-of-platform-transaction-delete","parameters":[{"name":"transactionId","in":"path","required":true,"schema":{"type":"string","description":"The `Transaction` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}},{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Advanced authentication](ref:advanced-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","example":"{{fingerprint}}"}},{"name":"X-Soldo-Fingerprint-Signature","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint_signature}}","description":"[Advanced authentication](ref:advanced-authentication): Signature of the `X-Soldo-Fingerprint`.","example":"{{fingerprint_signature}}"}}],"responses":{"204":{"description":"No content as result."}},"security":[{"standardAuth":["transaction_write"]}],"x-soldo":{"fingerprint-order":"transactionId, token"}}},"/business/v2/purchases/{purchaseId}":{"get":{"tags":["Pre-approved Spend"],"summary":"Get Purchases","description":"Endpoint to get a specific `Purchase` by ID.","operationId":"pre-approved-spend-get","parameters":[{"name":"purchaseId","in":"path","required":true,"schema":{"type":"string","description":"The `Purchase` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}}],"responses":{"200":{"description":"The returned resource is a single `Purchase`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Purchase"}}}},"400":{"description":"Your request has missing arguments or is malformed."}},"security":[{"standardAuth":["purchase_read"]}]},"put":{"tags":["Pre-approved Spend"],"summary":"Update Purchase","description":"Endpoint to update a specific `Purchase`.","operationId":"pre-approved-spend-update","parameters":[{"name":"purchaseId","in":"path","required":true,"schema":{"type":"string","description":"The `Purchase` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}},{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Advanced authentication](ref:advanced-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","example":"{{fingerprint}}"}},{"name":"X-Soldo-Fingerprint-Signature","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint_signature}}","description":"[Advanced authentication](ref:advanced-authentication): Signature of the `X-Soldo-Fingerprint`.","example":"{{fingerprint_signature}}"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePurchase"}}}},"responses":{"200":{"description":"The returned resource is a single `Purchase`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Purchase"}}}},"400":{"description":"Your request has missing arguments or is malformed."}},"security":[{"standardAuth":["purchase_write"]}],"x-soldo":{"fingerprint-order":"purchaseId, title, description, max_tx_number, token"}},"delete":{"tags":["Pre-approved Spend"],"summary":"Delete Purchase","description":"Endpoint to delete a specific `Purchase`.","operationId":"pre-approved-spend-delete","parameters":[{"name":"purchaseId","in":"path","required":true,"schema":{"type":"string","description":"The `Purchase` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}}],"responses":{"204":{"description":"No content as result."},"400":{"description":"Your request has missing arguments or is malformed."}},"security":[{"standardAuth":["purchase_write"]}]}},"/business/v2/requests/{requestId}":{"get":{"tags":["Requests"],"summary":"Get Request","description":"Endpoint to get an `Request` by ID.\nThere are 3 types of request:GOODS_OR_SERVICES, FUNDS,TRIP.","operationId":"request-get","parameters":[{"name":"requestId","in":"path","required":true,"schema":{"type":"string","description":"The `Request` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}}],"responses":{"200":{"description":"The returned resource is a single `Request`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestPayload"},"examples":{"GoodOrServicesResponseExample":{"summary":"type GOODS_OR_SERVICES","description":"GoodOrServicesResponseExample","value":{"id":"776f5018-07e5-426b-a426-8b23fa1e985d","type":"GOODS_OR_SERVICES","name":"Goods or Services","amount":150,"currency":"EUR","status":"PENDING","request_process_id":"7bf79328-a7ae-4222-aa54-091ff7f429a7","number_transactions":"1","payment_method":"card","description":"TYPE GOOD_SERVICES","requester":"LVRS6404-000089","approveDate":"2025-12-03T14:19:36Z","hasAttachments":"false","note":"note","creation_time":"2025-12-03T14:15:14Z","last_update":"2025-12-03T14:19:36Z"}},"TripResponseExample":{"summary":"type TRIP","description":"TripResponseExample","value":{"id":"776f5018-07e5-426b-a426-8b23fa1e985d","type":"TRIP","name":"Trip","amount":"150.00","currency":"EUR","status":"PENDING","request_process_id":"7bf79328-a7ae-4222-aa54-091ff7f429a7","card_id":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa","description":"TYPE TRIP","requester":"LVRS6404-000089","approveDate":"2025-12-03T14:19:36Z","hasAttachments":"false","note":"note","destination":"Rome","date_from":"2025-12-24T23:00:00Z","date_to":"2025-12-26T22:59:59.999Z","traveller":"LVRS6404-000005","expense_allocation":[{"expense_category_id":"0145e140-fc56-4ffd-9a57-a3c776bb2b51","spend_period":"BEFORE_TRIP","amount":1,"amount_currency":"EUR"}],"tags":[],"creation_time":"2025-12-03T14:15:14Z","last_update":"2025-12-03T14:19:36Z"}},"FundResponseExample":{"summary":"type FUNDS","description":"FundResponseExample","value":{"id":"776f5018-07e5-426b-a426-8b23fa1e985d","type":"FUNDS","name":"Fund","amount":150,"currency":"EUR","status":"PENDING","request_process_id":"7bf79328-a7ae-4222-aa54-091ff7f429a7","card_id":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa","description":"TYPE FUNDS","requester":"LVRS6404-000089","approveDate":"2025-12-03T14:19:36Z","hasAttachments":"false","note":"note","creation_time":"2025-12-03T14:15:14Z","last_update":"2025-12-03T14:19:36Z"}}}}}},"400":{"description":"Your request has missing arguments or is malformed."},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["request_read"]}]},"put":{"tags":["Requests"],"summary":"Update Request","description":"Endpoint to update an `Request`. There are 3 types of request:GOODS_OR_SERVICES, FUNDS, TRIP.The update of GOODS_OR_SERVICES requests does not currently support Bank Transfer as a payment method.","operationId":"request-update","parameters":[{"name":"requestId","in":"path","required":true,"schema":{"type":"string","description":"The `Request` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}},{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Advanced authentication](ref:advanced-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","example":"{{fingerprint}}"}},{"name":"X-Soldo-Fingerprint-Signature","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint_signature}}","description":"[Advanced authentication](ref:advanced-authentication): Signature of the `X-Soldo-Fingerprint`.","example":"{{fingerprint_signature}}"}}],"requestBody":{"description":"Update `request` JSON parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateRequestPayload"}}}},"responses":{"200":{"description":"The returned resource is the single `Request` created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestPayload"},"examples":{"GoodOrServicesResponseExample":{"summary":"type GOODS_OR_SERVICES","description":"GoodOrServicesResponseExample","value":{"id":"776f5018-07e5-426b-a426-8b23fa1e985d","type":"GOODS_OR_SERVICES","name":"Goods or Services","amount":150,"currency":"EUR","status":"PENDING","request_process_id":"7bf79328-a7ae-4222-aa54-091ff7f429a7","number_transactions":"1","payment_method":"card","description":"TYPE GOOD_SERVICES","requester":"LVRS6404-000089","approveDate":"2025-12-03T14:19:36Z","hasAttachments":"false","note":"note","creation_time":"2025-12-03T14:15:14Z","last_update":"2025-12-03T14:19:36Z"}},"TripResponseExample":{"summary":"type TRIP","description":"TripResponseExample","value":{"id":"776f5018-07e5-426b-a426-8b23fa1e985d","type":"TRIP","name":"Trip","amount":"150.00","currency":"EUR","status":"PENDING","request_process_id":"7bf79328-a7ae-4222-aa54-091ff7f429a7","card_id":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa","description":"TYPE TRIP","requester":"LVRS6404-000089","approveDate":"2025-12-03T14:19:36Z","hasAttachments":"false","note":"note","destination":"Rome","date_from":"2025-12-24T23:00:00Z","date_to":"2025-12-26T22:59:59.999Z","traveller":"LVRS6404-000005","expense_allocation":[{"expense_category_id":"0145e140-fc56-4ffd-9a57-a3c776bb2b51","spend_period":"BEFORE_TRIP","amount":1,"amount_currency":"EUR"}],"tags":[],"creation_time":"2025-12-03T14:15:14Z","last_update":"2025-12-03T14:19:36Z"}},"FundResponseExample":{"summary":"type FUNDS","description":"FundResponseExample","value":{"id":"776f5018-07e5-426b-a426-8b23fa1e985d","type":"FUNDS","name":"Fund","amount":150,"currency":"EUR","status":"PENDING","request_process_id":"7bf79328-a7ae-4222-aa54-091ff7f429a7","card_id":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa","description":"TYPE FUNDS","requester":"LVRS6404-000089","approveDate":"2025-12-03T14:19:36Z","hasAttachments":"false","note":"note","creation_time":"2025-12-03T14:15:14Z","last_update":"2025-12-03T14:19:36Z"}}}}}},"400":{"description":"Your request has missing arguments or is malformed."},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["request_write"]}],"x-soldo":{"fingerprint-order":"id, request_timestamp, name, token"}},"delete":{"tags":["Requests"],"summary":"Delete Request","description":"Endpoint to remove an `Request`.The removal of GOODS_OR_SERVICES requests does not currently support Bank Transfer as a payment method.","operationId":"request-delete","parameters":[{"name":"requestId","in":"path","required":true,"schema":{"type":"string","description":"The `Request` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}}],"responses":{"204":{"description":"No content as result."},"400":{"description":"Your request has missing arguments or is malformed."}},"security":[{"standardAuth":["request_write"]}]}},"/business/v2/resource-sets/{id}":{"get":{"tags":["Resource Sets"],"summary":"Get Resource Set","description":"Endpoint to get a specific `ResourceSet` by ID.","operationId":"resource-set-get","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","description":"The `ResourceSet` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}}],"responses":{"200":{"description":"The returned resource is a single `ResourceSet`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceSet"}}}},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["resource_set_read"]}]},"put":{"tags":["Resource Sets"],"summary":"Update Resource Set","description":"Endpoint to update a `ResourceSet`.","operationId":"resource-set-update","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","description":"The `ResourceSet` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}},{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Advanced authentication](ref:advanced-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","example":"{{fingerprint}}"}},{"name":"X-Soldo-Fingerprint-Signature","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint_signature}}","description":"[Advanced authentication](ref:advanced-authentication): Signature of the `X-Soldo-Fingerprint`.","example":"{{fingerprint_signature}}"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateResourceSet"}}}},"responses":{"200":{"description":"The returned resource is a single `ResourceSet`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceSet"}}}},"400":{"description":"Your request has missing arguments or is malformed."},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["resource_set_write"]}],"x-soldo":{"fingerprint-order":"resourceSetId, name, description, token"}},"delete":{"tags":["Resource Sets"],"summary":"Delete Resource Set","description":"Endpoint to delete a specific `ResourceSet` by ID.","operationId":"resource-set-delete","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","description":"The `ResourceSet` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}}],"responses":{"204":{"description":"No content as result."},"400":{"description":"Your request has missing arguments or is malformed."}},"security":[{"standardAuth":["resource_set_write"]}]}},"/business/v2/dictionaries/{listId}/tags/{tagId}":{"get":{"tags":["Tags"],"summary":"Get Tag","description":"Endpoint to get a specific `Tag` of a given `List` by ID.","operationId":"tag-get","parameters":[{"name":"listId","in":"path","required":true,"schema":{"type":"string","description":"The `List` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}},{"name":"tagId","in":"path","required":true,"schema":{"type":"string","description":"The `Tag` ID.","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"}}],"responses":{"200":{"description":"The returned resource is a single `Tag`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Tag"}}}},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["tag_read"]}]},"put":{"tags":["Tags"],"summary":"Update Tag","description":"Endpoint to update `Tag` data of a `List`.","operationId":"tag-update","parameters":[{"name":"listId","in":"path","description":"The `List` ID.","required":true,"schema":{"type":"string","description":"The `List` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},{"name":"tagId","in":"path","description":"The `Tag` ID.","required":true,"schema":{"type":"string","description":"The `Tag` ID.","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"},"example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"tag":{"type":"string","description":"The name of the `Tag`.","example":"tx-label"},"description":{"type":"string","description":"The description of the `Tag`. If needed to support special characters, provide the character encoding in the `Content-Type` header (e.g. `application/x-www-form-urlencoded ; charset=utf-8`).","example":"Label to mark transactions"},"code":{"type":"string","description":"The code of the `Tag`. If needed to support special characters, provide the character encoding in the `Content-Type` header (e.g. `application/x-www-form-urlencoded ; charset=utf-8`).","example":"CODE tag","maxLength":60},"visible":{"type":"boolean","description":"It determines whether the `Tag` is visible in the `Transaction` detail.","example":true}}}}}},"responses":{"200":{"description":"The returned resource is a single `Tag`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Tag"}}}},"400":{"description":"Your request has missing arguments or is malformed."},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["tag_write"]}]},"delete":{"tags":["Tags"],"summary":"Delete Tag from List","description":"Endpoint to delete a `Tag` out of a `List`.","operationId":"tag-delete","parameters":[{"name":"listId","in":"path","required":true,"schema":{"type":"string","description":"The `List` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}},{"name":"tagId","in":"path","required":true,"schema":{"type":"string","description":"The `Tag` ID.","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"}}],"responses":{"204":{"description":"No content as result."},"400":{"description":"Your request has missing arguments or is malformed."},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["tag_write"]}]}},"/business/v2/entities/tax-rate/{taxRateId}":{"get":{"tags":["VAT Rates"],"summary":"Get VAT Rate","description":"Endpoint to retrieve a specific `VatRate` by ID.","operationId":"vat-rate-get","parameters":[{"name":"taxRateId","in":"path","required":true,"schema":{"type":"string","description":"The `VatRate` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}}],"responses":{"200":{"description":"The returned resource is a single `VatRate`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VatRate"}}}},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["tax_rate_read"]}]},"put":{"tags":["VAT Rates"],"summary":"Update VAT Rate","description":"Endpoint to update `VATRate`.","operationId":"vat-rate-update","parameters":[{"name":"taxRateId","in":"path","required":true,"schema":{"type":"string","description":"The `VatRate` ID."}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateVatRate"}}}},"responses":{"200":{"description":"The returned resource is a single `VatRate`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VatRate"}}}},"400":{"description":"Your request has missing arguments or is malformed."},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["tax_rate_write"]}]},"delete":{"tags":["VAT Rates"],"summary":"Delete VAT Rate","description":"Endpoint to delete a `VatRate`.","operationId":"vat-rate-delete","parameters":[{"name":"taxRateId","in":"path","required":true,"schema":{"type":"string","description":"The `VatRate` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}}],"responses":{"204":{"description":"No content as result."}},"security":[{"standardAuth":["tax_rate_write"]}]}},"/business/v2/vehicles/{vehicleId}":{"get":{"tags":["Vehicles"],"summary":"Get Vehicle","description":"Endpoint to get a specific `Vehicle` by ID.","operationId":"vehicle-get","parameters":[{"name":"vehicleId","in":"path","required":true,"schema":{"type":"string","description":"The Vehicle id.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}}],"responses":{"200":{"description":"The returned resource is a `Vehicle`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Vehicle"}}}},"400":{"description":"Your request has missing arguments or is malformed."}},"security":[{"standardAuth":["vehicle_read"]}]},"put":{"tags":["Vehicles"],"summary":"Update Vehicle","description":"Endpoint to update a specific Vehicle","operationId":"vehicle-update","parameters":[{"name":"vehicleId","in":"path","required":true,"schema":{"type":"string","description":"The Vehicle id.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateVehicle"}}}},"responses":{"400":{"description":"Your request has missing arguments or is malformed."},"default":{"description":"The returned resource is a `Vehicle`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Vehicle"}}}}},"security":[{"standardAuth":["vehicle_write"]}]},"delete":{"tags":["Vehicles"],"summary":"Delete Vehicle","description":"Endpoint to delete a specific `Vehicle`.","operationId":"vehicle-delete","parameters":[{"name":"vehicleId","in":"path","required":true,"schema":{"type":"string","description":"The Vehicle id.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}}],"responses":{"204":{"description":"No content as result."},"400":{"description":"Your request has missing arguments or is malformed."}},"security":[{"standardAuth":["vehicle_write"]}]}},"/business/v2/webhooks/subscriptions/{webhookSubscriptionId}":{"put":{"tags":["Webhook Subscriptions"],"summary":"Update Webhook Subscription","description":"Endpoint to update a specific `WebhookSubscription`.","operationId":"webhook-subscription-update","parameters":[{"name":"webhookSubscriptionId","in":"path","required":true,"schema":{"type":"string","description":"The `WebhookSubscription` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}},{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Advanced authentication](ref:advanced-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","example":"{{fingerprint}}"}},{"name":"X-Soldo-Fingerprint-Signature","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint_signature}}","description":"[Advanced authentication](ref:advanced-authentication): Signature of the `X-Soldo-Fingerprint`.","example":"{{fingerprint_signature}}"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateWebhookSubscription"}}}},"responses":{"200":{"description":"The returned resource is a single `WebhookSubscription`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookSubscription"}}}},"400":{"description":"Your request has missing arguments or is malformed."},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["webhook_subscription_write"]}],"x-soldo":{"fingerprint-order":"webhookSubscriptionId, webhook_url, enabled_events (joined), active, token"}},"delete":{"tags":["Webhook Subscriptions"],"summary":"Delete Webhook Subscription","description":"Endpoint to delete a specific `WebhookSubscription`.","operationId":"webhook-subscription-delete","parameters":[{"name":"webhookSubscriptionId","in":"path","required":true,"schema":{"type":"string","description":"The `WebhookSubscription` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}},{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Advanced authentication](ref:advanced-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","example":"{{fingerprint}}"}},{"name":"X-Soldo-Fingerprint-Signature","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint_signature}}","description":"[Advanced authentication](ref:advanced-authentication): Signature of the `X-Soldo-Fingerprint`.","example":"{{fingerprint_signature}}"}}],"responses":{"204":{"description":"No content as result."},"400":{"description":"Your request has missing arguments or is malformed."}},"security":[{"standardAuth":["webhook_subscription_write"]}],"x-soldo":{"fingerprint-order":"id, token"}}},"/business/v2/employees/{userId}/roles":{"get":{"tags":["User Roles"],"summary":"Get User Roles","description":"Endpoint to retrieve roles by `User` ID.","operationId":"user-role-get","parameters":[{"name":"userId","in":"path","required":true,"schema":{"type":"string","description":"The `User` ID.","example":"XMPL1234-000001"}}],"responses":{"200":{"description":"The result is the `User` with their `Roles`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssignedUserRoles"}}}},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["employee_read"]}]}},"/business/v2/employees":{"get":{"tags":["Users"],"summary":"Search Users","description":"Endpoint to find `Users` using filtering parameters.","operationId":"user-search","parameters":[{"name":"customreferenceId","in":"query","description":"The reference of the `User` in an external system.","schema":{"type":"string","description":"The reference of the `User` in an external system.","example":"IDEMPLOY111"},"example":"IDEMPLOY111"},{"name":"name","in":"query","description":"The name of the `User`.","schema":{"type":"string","description":"The name of the `User`.","example":"John"},"example":"John"},{"name":"surname","in":"query","description":"The surname of the `User`.","schema":{"type":"string","description":"The surname of the `User`.","example":"Doe"},"example":"Doe"},{"name":"visible","in":"query","description":"The visibility property of the `User`.","schema":{"type":"boolean","description":"The visibility property of the `User`.","example":true},"example":true},{"name":"jobTitle","in":"query","description":"The job title of the `User`.","schema":{"type":"string","description":"The job title of the `User`.","example":"HR Specialist"},"example":"HR Specialist"},{"name":"department","in":"query","description":"The department of the `User`.","schema":{"type":"string","description":"The department of the `User`.","example":"HR departement"},"example":"HR departement"},{"name":"email","in":"query","description":"The email address of the `User`.","schema":{"type":"string","description":"The email address of the `User`.","example":"johndoe@email.com"},"example":"johndoe@email.com"},{"name":"mobile","in":"query","description":"The mobile number of the `User`.","schema":{"type":"string","description":"The mobile number of the `User`.","example":"johndoe@email.com"},"example":"johndoe@email.com"},{"name":"status","in":"query","description":"The status of the `User`.","schema":{"$ref":"#/components/schemas/UserStatus"},"example":"ACTIVE"},{"name":"id","in":"query","description":"The ID of the `User`.","schema":{"type":"string","description":"The ID of the `User`.","example":"XMPL1234-000001"},"example":"XMPL1234-000001"},{"name":"groupId","in":"query","description":"The ID of the `Group` the `User` is a member of.","schema":{"type":"string","description":"The ID of the `Group` the `User` is a member of.","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"},"example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"},{"name":"reportsTo","in":"query","schema":{"type":"array","description":"The IDs of the `User` to which they could report to.","example":["XMPL1234-000001","XMPL1234-000002","XMPL1234-000003"],"items":{"type":"string","description":"The IDs of the `User` to which they could report to.","example":"[\"XMPL1234-000001\",\"XMPL1234-000002\",\"XMPL1234-000003\"]"}}},{"name":"workStatus","in":"query","schema":{"type":"array","description":"Filters users by their work status.","items":{"$ref":"#/components/schemas/WorkStatus"},"uniqueItems":true}},{"name":"p","in":"query","description":"It indicates the specific page to display (the counter starts from zero).","schema":{"type":"integer","format":"int32","default":0,"description":"It indicates the specific page to display (the counter starts from zero).","example":3},"example":3},{"name":"s","in":"query","description":"It indicates the number of items per page.","schema":{"type":"integer","format":"int32","default":0,"description":"It indicates the number of items per page.","example":25,"maximum":50},"example":25},{"name":"d","in":"query","description":"It indicates how the pages are ordered.","schema":{"$ref":"#/components/schemas/Direction"},"example":"DESC"},{"name":"props","in":"query","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.","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"}},"example":"creationTime"}],"responses":{"200":{"description":"The result array contains `Users`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Users"}}}},"400":{"description":"Your request has missing arguments or is malformed."}},"security":[{"standardAuth":["employee_read"]}]}},"/business/v2/expense-reports/{expenseReportId}/download":{"get":{"tags":["Expense Reports"],"summary":"Download Expense Report","description":"Endpoint to download `ExpenseReport` by ID.","operationId":"expense-report-download","parameters":[{"name":"expenseReportId","in":"path","required":true,"schema":{"type":"string","description":"The `ExpenseReport` ID .","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}},{"name":"fileType","in":"query","description":"The `ExpenseReport` file type.","schema":{"$ref":"#/components/schemas/ExpenseReportFileType"},"example":"PDF"}],"responses":{"200":{"description":"The result is a URL to download `ExpenseReport`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExpenseReportDownload"}}}},"400":{"description":"Your request has missing arguments or is malformed."}},"security":[{"standardAuth":["expense_report_read"]}]}},"/business/v2/expense-review/{userId}":{"get":{"tags":["Expense Reviews"],"summary":"Get Expense Review","description":"Endpoint to get the `ExpenseReview` of a specific `User`.","operationId":"expense-review-get","parameters":[{"name":"userId","in":"path","required":true,"schema":{"type":"string","description":"The ID of the `User`.","example":"XMPL1234-000001"}},{"name":"status","in":"query","description":"The status of the `ExpenseReview`.","schema":{"type":"array","description":"The status of the `ExpenseReview`.","example":"APPROVED","items":{"$ref":"#/components/schemas/ExpenseStatus"}},"example":"APPROVED"},{"name":"fromDate","in":"query","description":"The beginning of the period of the search `fromDate` included (i.e. greater than or equal to) (Formats: `yyyy-MM-dd`, `yyyy-MM-ddThh:mm:ss`, `yyyy-MM-ddThh:mm:ssZ`).","schema":{"$ref":"#/components/schemas/DateParam"},"example":"2020-04-06T12:48:40Z"},{"name":"toDate","in":"query","description":"The end of the period of the search `toDate` included (i.e. less than) (Formats: `yyyy-MM-dd`, `yyyy-MM-ddThh:mm:ss`, `yyyy-MM-ddThh:mm:ssZ`).","schema":{"$ref":"#/components/schemas/DateParam"},"example":"2020-05-07T12:48:40Z"},{"name":"paymentMethod","in":"query","description":"It determines the filter by payment method of the transaction.","schema":{"type":"array","description":"It determines the filter by payment method of the transaction.","items":{"$ref":"#/components/schemas/ExpensePaymentMethod"}},"example":"SUBSCRIPTION"},{"name":"p","in":"query","description":"It indicates the specific page to display (the counter starts from zero).","schema":{"type":"integer","format":"int32","default":0,"description":"It indicates the specific page to display (the counter starts from zero).","example":3},"example":3},{"name":"s","in":"query","description":"It indicates the number of items per page.","schema":{"type":"integer","format":"int32","default":0,"description":"It indicates the number of items per page.","example":25,"maximum":50},"example":25},{"name":"d","in":"query","description":"It indicates how the pages are ordered.","schema":{"$ref":"#/components/schemas/Direction"},"example":"DESC"},{"name":"props","in":"query","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.","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"}},"example":"creationTime"}],"responses":{"200":{"description":"The returned resource is a `ExpenseReview`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExpenseItem"}}}},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["expense_review_read"]}]}},"/business/v2/expense-review/{userId}/reminder":{"post":{"tags":["Expense Reviews"],"summary":"Send Expense Review Reminder","description":"Endpoint to send a reminder of `ExpenseReview` to a specific `User`.","operationId":"expense-review-reminder","parameters":[{"name":"userId","in":"path","required":true,"schema":{"type":"string","description":"The ID of the `User`.","example":"XMPL1234-000001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendExpensesReminder"}}}},"responses":{"204":{"description":"No content as result."},"400":{"description":"Your request has missing arguments or is malformed."}},"security":[{"standardAuth":["expense_review_read"]}]}},"/business/v2/expense-review/export-expenses/{userId}":{"post":{"tags":["Expense Reviews"],"summary":"Export Expense Review","description":"Endpoint to export the `ExpenseReview` of a single `User`.","operationId":"expense-review-export","parameters":[{"name":"userId","in":"path","required":true,"schema":{"type":"string","description":"The `User` ID.","example":"XMPL1234-000001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportExpense"}}}},"responses":{"200":{"description":"The result is data containing `ExpenseReview` export.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportExpenseReview"}}}},"400":{"description":"Your request has missing arguments or is malformed."},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["expense_review_write"]}]}},"/business/v2/cards/{cardId}/rules":{"get":{"tags":["Card Rules"],"summary":"Get Card Rules","description":"Endpoint to get the `CardRules` of the `Card`.","operationId":"card-rules-get","parameters":[{"name":"cardId","in":"path","required":true,"schema":{"type":"string","description":"The `Card` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}}],"responses":{"200":{"description":"The returned resource is a list of `CardRule`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CardRuleList"}}}},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["card_read"]}]},"put":{"tags":["Card Rules"],"summary":"Set Card Rules","description":"Endpoint to set the `CardRules`.","operationId":"card-rules-set","parameters":[{"name":"cardId","in":"path","required":true,"schema":{"type":"string","description":"The `Card` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}},{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Advanced authentication](ref:advanced-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","example":"{{fingerprint}}"}},{"name":"X-Soldo-Fingerprint-Signature","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint_signature}}","description":"[Advanced authentication](ref:advanced-authentication): Signature of the `X-Soldo-Fingerprint`.","example":"{{fingerprint_signature}}"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCardRules"}}}},"responses":{"200":{"description":"The result is a list of `CardRule`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CardRuleList"}}}},"400":{"description":"Your request has missing arguments or is malformed."},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["card_write"]}],"x-soldo":{"fingerprint-order":"name, enabled, token"}}},"/business/v2/transactions/{transactionId}/metadata":{"get":{"tags":["Transaction Metadata"],"summary":"Search Transaction Metadata","description":"Endpoint to get the list of metadata of a `Transaction`.","operationId":"transaction-metadata-search","parameters":[{"name":"transactionId","in":"path","required":true,"schema":{"type":"string","description":"The `Transaction` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}},{"name":"p","in":"query","description":"It indicates the specific page to display (the counter starts from zero).","schema":{"type":"integer","format":"int32","default":0,"description":"It indicates the specific page to display (the counter starts from zero).","example":3},"example":3},{"name":"s","in":"query","description":"It indicates the number of items per page.","schema":{"type":"integer","format":"int32","default":0,"description":"It indicates the number of items per page.","example":25,"maximum":50},"example":25},{"name":"d","in":"query","description":"It indicates how the pages are ordered.","schema":{"$ref":"#/components/schemas/Direction"},"example":"DESC"},{"name":"props","in":"query","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.","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"}},"example":"creationTime"}],"responses":{"200":{"description":"The results array contains metadata.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionMetadataList"}}}},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["transaction_read"]}]}},"/business/v2/wallets/autotransfer-presets/{presetId}":{"get":{"tags":["Auto-Transfer Presets"],"summary":"Get Auto-transfer Preset","description":"Endpoint to get `AutoTransferPreset` by ID.","operationId":"wallet-auto-transfer-preset-get","parameters":[{"name":"presetId","in":"path","description":"The `AutoTransferPreset` ID","required":true,"schema":{"type":"string"},"example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"}],"responses":{"200":{"description":"The returned resource is an `AutoTransferPreset`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WalletAutotransferPreset"}}}},"400":{"description":"Your request has missing arguments or is malformed."}},"security":[{"standardAuth":["wallet_read"]}]}},"/business/v2/wallets/internalTransfer/{fromWalletId}/{toWalletId}":{"put":{"tags":["Wallets"],"summary":"Make Internal Transfer","description":"Endpoint to transfer money between two `Wallets` within the same business account.","operationId":"wallet-internal-transfer","parameters":[{"name":"fromWalletId","in":"path","required":true,"schema":{"type":"string","description":"The `Wallet` ID of the source `Wallet`.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}},{"name":"toWalletId","in":"path","required":true,"schema":{"type":"string","description":"The `Wallet` ID of the destination `Wallet`.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}},{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Advanced authentication](ref:advanced-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","example":"{{fingerprint}}"}},{"name":"X-Soldo-Fingerprint-Signature","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint_signature}}","description":"[Advanced authentication](ref:advanced-authentication): Signature of the `X-Soldo-Fingerprint`.","example":"{{fingerprint_signature}}"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"amount":{"type":"number","description":"The amount to transfer.","example":10.25},"currencyCode":{"$ref":"#/components/schemas/ISO4217SupportedCurrency"}},"required":["amount","currencyCode"]}}}},"responses":{"200":{"description":"The result is a `TransferResult`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransferResult"}}}},"400":{"description":"Your request has missing arguments or is malformed."},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["wallet_write"]}],"x-soldo":{"fingerprint-order":"amount, currencyCode, fromWalletId, toWalletId, token"}}},"/business/v2/transactions/{transactionId}/attachments":{"get":{"tags":["Transaction Attachments"],"summary":"Search Transaction Attachments","description":"Endpoint to get the list of `TransactionAttachments` of a `Transaction`.","operationId":"transaction-attachment-search","parameters":[{"name":"transactionId","in":"path","required":true,"schema":{"type":"string","description":"The `Transaction` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}}],"responses":{"200":{"description":"The returned array contains `TransactionAttachment`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionAttachments"}}}},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["transaction_read"]}]},"post":{"tags":["Transaction Attachments"],"summary":"Upload Transaction Attachment","description":"Endpoint to upload a `TransactionAttachment` to a `Transaction`.\nThe first step is to get a temporary URL where to upload the attachment file.","operationId":"transaction-attachment-upload","parameters":[{"name":"transactionId","in":"path","required":true,"schema":{"type":"string","description":"The `Transaction` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"fileName":{"type":"string","description":"The file name of the attachment.","example":"invoice87.jpg"},"fileType":{"type":"string","description":"The file type of the attachment.","example":"PDF"}}}}}},"responses":{"200":{"description":"The returned resource is a single `TransactionAttachment`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionAttachment"}}}},"400":{"description":"Your request has missing arguments or is malformed."},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["transaction_write"]}]}},"/business/v2/orders":{"get":{"tags":["Orders"],"summary":"Search Orders","description":"Endpoint to retrieve your `Orders`.","operationId":"order-search","parameters":[{"name":"id","in":"query","description":"The `Order` ID.","schema":{"type":"string","description":"The `Order` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},{"name":"status","in":"query","description":"The status of the `Order`.","schema":{"$ref":"#/components/schemas/OrderStatus"},"example":"PENDING"},{"name":"fromDate","in":"query","description":"The beginning of the period of the search `fromDate` included (i.e. greater than or equal to) (Formats: `yyyy-MM-dd`, `yyyy-MM-ddThh:mm:ss`, `yyyy-MM-ddThh:mm:ssZ`).","schema":{"$ref":"#/components/schemas/DateParam"},"example":"2020-04-06T12:48:40Z"},{"name":"toDate","in":"query","description":"The end of the period of the search `toDate` included (i.e. less than) (Formats: `yyyy-MM-dd`, `yyyy-MM-ddThh:mm:ss`, `yyyy-MM-ddThh:mm:ssZ`).","schema":{"$ref":"#/components/schemas/DateParam"},"example":"2020-05-07T12:48:40Z"},{"name":"p","in":"query","description":"It indicates the specific page to display (the counter starts from zero).","schema":{"type":"integer","format":"int32","default":0,"description":"It indicates the specific page to display (the counter starts from zero).","example":3},"example":3},{"name":"s","in":"query","description":"It indicates the number of items per page.","schema":{"type":"integer","format":"int32","default":0,"description":"It indicates the number of items per page.","example":25,"maximum":50},"example":25},{"name":"d","in":"query","description":"It indicates how the pages are ordered.","schema":{"$ref":"#/components/schemas/Direction"},"example":"DESC"},{"name":"props","in":"query","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.","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"}},"example":"creationTime"}],"responses":{"200":{"description":"The result is an array containing `Orders`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders"}}}},"400":{"description":"Your request has missing arguments or is malformed."}},"security":[{"standardAuth":["company_read"]}]}},"/business/v2/expense-review/processes/recalculate":{"post":{"tags":["Expense Review Processes"],"summary":"Recalculate Expense Review Process ","description":"Endpoint to recalculate the `ExpenseReviewProcess` a transaction is included into. This is particularly useful in case a change made on an `ExpenseReviewProcess` configuration should be applied to already existing transactions. In case a recalculated transaction is included into the same `ExpenseReviewProcess`, the transaction will remain assigned to the same approval step. This endpoint supports up to 100 transactions per single request.","operationId":"expense-review-process-recalculate","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecalculateExpenseReviewProcess"}}}},"responses":{"204":{"description":"No content as result."},"400":{"description":"Your request has missing arguments or is malformed."},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["expense_review_write"]}]}},"/business/v2/refueling/{refuelingId}":{"get":{"tags":["Refueling Transactions"],"summary":"Get Refueling Transaction","description":"Endpoint to get a specific `Refueling` by ID.","operationId":"refueling-get","parameters":[{"name":"refuelingId","in":"path","required":true,"schema":{"type":"string","description":"The `Refueling` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}},{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Advanced authentication](ref:advanced-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","example":"{{fingerprint}}"}},{"name":"X-Soldo-Fingerprint-Signature","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint_signature}}","description":"[Advanced authentication](ref:advanced-authentication): Signature of the `X-Soldo-Fingerprint`.","example":"{{fingerprint_signature}}"}}],"responses":{"200":{"description":"The returned resource is a single `Refueling`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refueling"}}}},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["transaction_read"]}],"x-soldo":{"fingerprint-order":"refuelingId, token"}},"put":{"tags":["Refueling Transactions"],"summary":"Update Refueling Transaction","description":"Endpoint to update a specific `Refueling` by ID.","operationId":"refueling-update","parameters":[{"name":"refuelingId","in":"path","required":true,"schema":{"type":"string","description":"The `Refueling` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}},{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Advanced authentication](ref:advanced-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","example":"{{fingerprint}}"}},{"name":"X-Soldo-Fingerprint-Signature","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint_signature}}","description":"[Advanced authentication](ref:advanced-authentication): Signature of the `X-Soldo-Fingerprint`.","example":"{{fingerprint_signature}}"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateRefueling"}}}},"responses":{"200":{"description":"The returned resource is a single `Refueling`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refueling"}}}},"400":{"description":"Your request has missing arguments or is malformed."},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["transaction_write"]}],"x-soldo":{"fingerprint-order":"refuelingId, mileage, quantity, txFuelType, unitPrice, token"}}},"/business/v2/refueling":{"get":{"tags":["Refueling Transactions"],"summary":"Search Refueling Transactions","description":"Endpoint to search `Refuelings` using filtering parameters.","operationId":"refueling-search","parameters":[{"name":"type","in":"query","description":"The resource `type` to be used together with id.","schema":{"$ref":"#/components/schemas/RefuelingType"},"example":"card"},{"name":"publicId","in":"query","description":"The ID of the `type` resource.","schema":{"type":"string","description":"The ID of the `type` resource.","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"},"example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"},{"name":"fromDate","in":"query","description":"The beginning of the period of the search `fromDate` included (i.e. greater than or equal to) (Formats: `yyyy-MM-dd`, `yyyy-MM-ddThh:mm:ss`, `yyyy-MM-ddThh:mm:ssZ`).","schema":{"$ref":"#/components/schemas/DateParam"},"example":"2020-04-06T12:48:40Z"},{"name":"toDate","in":"query","description":"The end of the period of the search `toDate` included (i.e. less than) (Formats: `yyyy-MM-dd`, `yyyy-MM-ddThh:mm:ss`, `yyyy-MM-ddThh:mm:ssZ`).","schema":{"$ref":"#/components/schemas/DateParam"},"example":"2020-05-07T12:48:40Z"},{"name":"dateType","in":"query","description":"It determines the date to be considered for `fromDate` and `toDate` parameters.","schema":{"$ref":"#/components/schemas/TransactionDateType"},"example":"TRANSACTION"},{"name":"txCountry","in":"query","description":"The [ISO 3166-1 alpha-3](https://www.iso.org/obp/ui/#search/code/) code of the country where the `Transaction` was made.","schema":{"$ref":"#/components/schemas/ISO3166Country"},"example":"GBR"},{"name":"txStatus","in":"query","description":"A list of statuses the searched `Transactions` should be in.","schema":{"type":"array","description":"A list of statuses the searched `Transactions` should be in.","items":{"$ref":"#/components/schemas/TransactionStatus"}},"example":"Authorised"},{"name":"txFuelType","in":"query","description":"The fuel type specified on the `Transaction`.","schema":{"$ref":"#/components/schemas/FuelType"},"example":"PETROL"},{"name":"showFuelDetails","in":"query","description":"It determines whether to show further Fuel Details of the `Transaction`.","schema":{"type":"boolean","description":"It determines whether to show further Fuel Details of the `Transaction`.","example":true},"example":true},{"name":"p","in":"query","description":"It indicates the specific page to display (the counter starts from zero).","schema":{"type":"integer","format":"int32","default":0,"description":"It indicates the specific page to display (the counter starts from zero).","example":3},"example":3},{"name":"s","in":"query","description":"It indicates the number of items per page.","schema":{"type":"integer","format":"int32","default":0,"description":"It indicates the number of items per page.","example":25,"maximum":50},"example":25},{"name":"d","in":"query","description":"It indicates how the pages are ordered.","schema":{"$ref":"#/components/schemas/Direction"},"example":"DESC"},{"name":"props","in":"query","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.","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"}},"example":"creationTime"},{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Advanced authentication](ref:advanced-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","example":"{{fingerprint}}"}},{"name":"X-Soldo-Fingerprint-Signature","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint_signature}}","description":"[Advanced authentication](ref:advanced-authentication): Signature of the `X-Soldo-Fingerprint`.","example":"{{fingerprint_signature}}"}}],"responses":{"200":{"description":"The result is an array containing `Refuelings`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refuelings"}}}},"400":{"description":"Your request has missing arguments or is malformed."}},"security":[{"standardAuth":["transaction_read"]}],"x-soldo":{"fingerprint-order":"type, publicId, fromDate, toDate, dateType, txCountry, txStatus, txFuelType, token"}}},"/business/v2/online-ads/{onlineAdId}/removeAssignees":{"put":{"tags":["Online Ads"],"summary":"Remove assignees from Online Ads","description":"Endpoint to remove assignees from an `OnlineAd`.","operationId":"online-ads-assignees-remove","parameters":[{"name":"onlineAdId","in":"path","required":true,"schema":{"type":"string","description":"The `OnlineAd` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemoveAssignees"}}}},"responses":{"200":{"description":"The returned resource is a single `OnlineAd`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OnlineAds"}}}},"400":{"description":"Your request has missing arguments or is malformed."}},"security":[{"standardAuth":["online_ads_write"]}]}},"/business/v2/subscriptions/{subscriptionId}/removeAssignees":{"put":{"tags":["Subscriptions"],"summary":"Remove assignees from Subscription","description":"Endpoint to remove assignees from a `Subscription`.","operationId":"subscription-assignees-remove","parameters":[{"name":"subscriptionId","in":"path","required":true,"schema":{"type":"string","description":"The `Subscription` id.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemoveAssignees"}}}},"responses":{"200":{"description":"The returned resource is a `Subscription`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Subscription"}}}},"400":{"description":"Your request has missing arguments or is malformed."}},"security":[{"standardAuth":["subscription_write"]}]}},"/business/v2/transactions/custom-exports/bulk-remove":{"delete":{"tags":["Transaction Custom Export"],"summary":" Remove Bulk TransactionCustomExport","description":"Endpoint bulk to remove a list of `TransactionCustomExport` by TransactionIds.","operationId":"transaction-export-remove","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemoveTransactionCustomExport"}}}},"responses":{"200":{"description":"The result is an array containing `TransactionCustomExport`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemoveTransactionCustomExportBulk"}}}},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["transaction_write"]}]}},"/business/v2/transactions/{transactionId}/expense-category":{"delete":{"tags":["Transaction Expense Category"],"summary":"Remove Expense Category from Transaction","description":"Endpoint to remove the `Transaction`'s `ExpenseCategory`","operationId":"transaction-expense-category-unset","parameters":[{"name":"transactionId","in":"path","required":true,"schema":{"type":"string","description":"The `Transaction` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}}],"responses":{"204":{"description":"No content as result."},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["transaction_write"]}]}},"/business/v2/transactions/{transactionId}/tax-rate":{"delete":{"tags":["Transaction VAT Rate"],"summary":"Remove VAT Rate from Transaction ","description":"Endpoint to remove the `Transaction`'s `VatRate`","operationId":"transaction-tax-rate-unset","parameters":[{"name":"transactionId","in":"path","required":true,"schema":{"type":"string","description":"The `Transaction` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}}],"responses":{"204":{"description":"No content as result."},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["transaction_write"]}]}},"/business/v2/wallets/{walletId}":{"get":{"tags":["Wallets"],"summary":"Get Wallet","description":"Endpoint to retrieve a specific `Wallet` by ID.","operationId":"wallet-get","parameters":[{"name":"walletId","in":"path","required":true,"schema":{"type":"string","description":"The `Wallet` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}}],"responses":{"200":{"description":"The returned resource is a single `Wallet`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Wallet"}}}},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["wallet_read"]}]},"put":{"tags":["Wallets"],"summary":"Update Wallet","description":"Endpoint to update a `Wallet`. Only company wallets can be updated, a `User` dedicated wallet for each currency supported by your account is automatically created by the Soldo platform when a `User` gets created.","operationId":"wallet-update","parameters":[{"name":"walletId","in":"path","required":true,"schema":{"type":"string","description":"The `Wallet` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateWallet"}}}},"responses":{"200":{"description":"The returned resource is a single `Wallet`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Wallet"}}}},"400":{"description":"Your request has missing arguments or is malformed."},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["wallet_write"]}]},"delete":{"tags":["Wallets"],"summary":"Delete Wallet","description":"Endpoint to delete the `Wallet`","operationId":"wallet-delete","parameters":[{"name":"walletId","in":"path","required":true,"schema":{"type":"string","description":"The `Wallet` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}}],"responses":{"204":{"description":"No content as result."},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["wallet_write"]}]}},"/business/v2/wallets/presets/{presetId}":{"delete":{"tags":["Auto-Transfer Presets"],"summary":"Delete Auto-transfer Preset","description":"Endpoint to delete a `AutoTransferPreset` by ID.","operationId":"wallet-auto-transfer-preset-delete","parameters":[{"name":"presetId","in":"path","description":"The `AutoTransferPreset` ID.","required":true,"schema":{"type":"string"},"example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"}],"responses":{"204":{"description":"No content as result."},"400":{"description":"Your request has missing arguments or is malformed."},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["wallet_write"]}]}},"/business/v2/transactions/custom-exports/bulk-retrieve":{"post":{"tags":["Transaction Custom Export"],"summary":" Retrieve Bulk TransactionCustomExport","description":"Endpoint retrieve a list of `TransactionCustomExport` by TransactionIds.","operationId":"transaction-export-get","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionCustomExportBulk"}}}},"responses":{"200":{"description":"The result is an array containing `TransactionCustomExport`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveCustomExportTransaction"}}}},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["transaction_read"]}]}},"/business/v2/employees/{userId}/access-modes":{"get":{"tags":["Users"],"summary":"Retrieve User Access Modes","description":"Endpoint to retrieve the `User` access modes.","operationId":"user-access-modes-get","parameters":[{"name":"userId","in":"path","required":true,"schema":{"type":"string","description":"The `User` ID.","example":"XMPL1234-000001"}},{"name":"channel","in":"query","schema":{"$ref":"#/components/schemas/Channel"}}],"responses":{"200":{"description":"The access modes configure for the given `User`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserAccessModeList"}}}},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["employee_read"]}]},"put":{"tags":["Users"],"summary":"Update User Access Modes","description":"Endpoint to update the `User` access modes.","operationId":"user-access-modes-update","parameters":[{"name":"userId","in":"path","required":true,"schema":{"type":"string","description":"The `User` ID.","example":"XMPL1234-000001"}},{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Advanced authentication](ref:advanced-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","example":"{{fingerprint}}"}},{"name":"X-Soldo-Fingerprint-Signature","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint_signature}}","description":"[Advanced authentication](ref:advanced-authentication): Signature of the `X-Soldo-Fingerprint`.","example":"{{fingerprint_signature}}"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUserAccessModes"}}}},"responses":{"204":{"description":"No content as result."},"400":{"description":"Your request has missing arguments or is malformed."},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["employee_write"]}],"x-soldo":{"fingerprint-order":"request_timestamp, userId, token"}}},"/business/v2/cards/presets":{"get":{"tags":["Card Rules Presets"],"summary":"Search Presets","description":"Endpoint to find `CardRulePresets` using filtering parameters.","operationId":"card-rule-preset-search","parameters":[{"name":"currency","in":"query","description":"the currency of the `CardRulePreset`.","schema":{"type":"array","description":"the currency of the `CardRulePreset`.","items":{"$ref":"#/components/schemas/ISO4217Currency"}},"example":"EUR"},{"name":"name","in":"query","description":"The name of the `CardRulePreset`.","schema":{"type":"string","description":"The name of the `CardRulePreset`.","example":"DefaultPreset"},"example":"DefaultPreset"},{"name":"p","in":"query","description":"It indicates the specific page to display (the counter starts from zero).","schema":{"type":"integer","format":"int32","default":0,"description":"It indicates the specific page to display (the counter starts from zero).","example":3},"example":3},{"name":"s","in":"query","description":"It indicates the number of items per page.","schema":{"type":"integer","format":"int32","default":0,"description":"It indicates the number of items per page.","example":25,"maximum":50},"example":25},{"name":"d","in":"query","description":"It indicates how the pages are ordered.","schema":{"$ref":"#/components/schemas/Direction"},"example":"DESC"},{"name":"props","in":"query","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.","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"}},"example":"creationTime"}],"responses":{"200":{"description":"The results array contains `CardRulePreset`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CardRulePresets"}}}}},"security":[{"standardAuth":["card_write"]}]}},"/business/v2/expense-review":{"get":{"tags":["Expense Reviews"],"summary":"Search Expense Reviews","description":"Endpoint to find users with `ExpenseReview` using filtering parameters.","operationId":"expense-review-search","parameters":[{"name":"delegatedBy","in":"query","schema":{"type":"array","description":"Filters expenses by the user who delegated them.","example":"XMPL1234-000001","items":{"type":"string","description":"Filters expenses by the user who delegated them.","example":"XMPL1234-000001"}}},{"name":"fromDate","in":"query","description":"The beginning of the period of the search `fromDate` included (i.e. greater than or equal to) (Formats: `yyyy-MM-dd`, `yyyy-MM-ddThh:mm:ss`, `yyyy-MM-ddThh:mm:ssZ`).","schema":{"$ref":"#/components/schemas/DateParam"},"example":"2020-04-06T12:48:40Z"},{"name":"toDate","in":"query","description":"The end of the period of the search `toDate` included (i.e. less than) (Formats: `yyyy-MM-dd`, `yyyy-MM-ddThh:mm:ss`, `yyyy-MM-ddThh:mm:ssZ`).","schema":{"$ref":"#/components/schemas/DateParam"},"example":"2020-05-07T12:48:40Z"},{"name":"text","in":"query","description":"A text to search in the expenses reviewer name or surname.","schema":{"type":"string","description":"A text to search in the expenses reviewer name or surname.","example":"John"},"example":"John"},{"name":"p","in":"query","description":"It indicates the specific page to display (the counter starts from zero).","schema":{"type":"integer","format":"int32","default":0,"description":"It indicates the specific page to display (the counter starts from zero).","example":3},"example":3},{"name":"s","in":"query","description":"It indicates the number of items per page.","schema":{"type":"integer","format":"int32","default":0,"description":"It indicates the number of items per page.","example":25,"maximum":50},"example":25},{"name":"props","in":"query","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.","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"}},"example":"creationTime"}],"responses":{"200":{"description":"The returned resource is an array of `Expenses`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Expenses"}}}}},"security":[{"standardAuth":["expense_review_read"]}]}},"/business/v2/expense-reports":{"get":{"tags":["Expense Reports"],"summary":"Search Expense Reports","description":"Endpoint to search `ExpenseReport` using filtering parameters.","operationId":"expense-report-search","parameters":[{"name":"number","in":"query","description":"The `ExpenseReport` number.","schema":{"type":"string","description":"The `ExpenseReport` number.","example":"NR9912098"},"example":"NR9912098"},{"name":"trxOwnerId","in":"query","description":"The ID of the `User` who made the expenses included in the `ExpenseReport`.","schema":{"type":"string","description":"The ID of the `User` who made the expenses included in the `ExpenseReport`.","example":"XMPL1234-000003"},"example":"XMPL1234-000003"},{"name":"trxDateFrom","in":"query","description":"The beginning of the period of the search `fromDate` included (i.e. greater than or equal to) (Formats: `yyyy-MM-dd`, `yyyy-MM-ddThh:mm:ss`, `yyyy-MM-ddThh:mm:ssZ`).","schema":{"$ref":"#/components/schemas/DateParam"},"example":"2020-04-06T12:48:40Z"},{"name":"trxDateTo","in":"query","description":"The beginning of the period of the search `fromDate` included (i.e. greater than or equal to) (Formats: `yyyy-MM-dd`, `yyyy-MM-ddThh:mm:ss`, `yyyy-MM-ddThh:mm:ssZ`).","schema":{"$ref":"#/components/schemas/DateParam"},"example":"2020-04-06T12:48:40Z"},{"name":"status","in":"query","description":"The `ExpenseReport` status.","schema":{"type":"array","description":"The `ExpenseReport` status.","items":{"$ref":"#/components/schemas/ExpenseReportStatus"},"uniqueItems":true},"example":"PROCESSED"},{"name":"type","in":"query","description":"The `ExpenseReport` type.","schema":{"type":"array","description":"The `ExpenseReport` type.","items":{"$ref":"#/components/schemas/ExpenseReportType"},"uniqueItems":true},"example":"EMPLOYEE"},{"name":"toReimburse","in":"query","description":"It determines whether only reports with or without an amount to be reimbursed should be returned.","schema":{"type":"boolean","description":"It determines whether only reports with or without an amount to be reimbursed should be returned.","example":true},"example":true},{"name":"exportedDate","in":"query","description":"The date when the `ExpenseReport` got exported\n(Formats: yyyy-MM-dd, yyyy-MM-ddThh:mm:ss, yyyy-MM-ddThh:mm:ssZ).","schema":{"$ref":"#/components/schemas/DateParam"},"example":"2020-04-06T12:48:40Z"},{"name":"p","in":"query","description":"It indicates the specific page to display (the counter starts from zero).","schema":{"type":"integer","format":"int32","default":0,"description":"It indicates the specific page to display (the counter starts from zero).","example":3},"example":3},{"name":"s","in":"query","description":"It indicates the number of items per page.","schema":{"type":"integer","format":"int32","default":0,"description":"It indicates the number of items per page.","example":25,"maximum":50},"example":25},{"name":"d","in":"query","description":"It indicates how the pages are ordered.","schema":{"$ref":"#/components/schemas/Direction"},"example":"DESC"},{"name":"props","in":"query","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.","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"}},"example":"creationTime"}],"responses":{"200":{"description":"The result is an array containing `ExpenseReport`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExpenseReports"}}}},"400":{"description":"Your request has missing arguments or is malformed."}},"security":[{"standardAuth":["expense_report_read"]}]}},"/business/v2/transactions/custom-exports/search":{"get":{"tags":["Transaction Custom Export"],"summary":"Search TransactionCustomExport","description":"Endpoint to get the list of a `TransactionCustomExport`.","operationId":"transaction-export-search","parameters":[{"name":"fromDate","in":"query","description":"The beginning of the period of the search `fromDate` included (i.e. greater than or equal to) (Formats: `yyyy-MM-dd`, `yyyy-MM-ddThh:mm:ss`, `yyyy-MM-ddThh:mm:ssZ`).","schema":{"$ref":"#/components/schemas/DateParam"},"example":"2020-04-06T12:48:40Z"},{"name":"toDate","in":"query","description":"The end of the period of the search `toDate` included (i.e. less than) (Formats: `yyyy-MM-dd`, `yyyy-MM-ddThh:mm:ss`, `yyyy-MM-ddThh:mm:ssZ`).","schema":{"$ref":"#/components/schemas/DateParam"},"example":"2020-05-07T12:48:40Z"},{"name":"product","in":"query","description":"A product that exported list of `Transaction`","schema":{"type":"string","description":"A product that exported list of `Transaction`"},"example":"SAP"},{"name":"p","in":"query","description":"It indicates the specific page to display (the counter starts from zero).","schema":{"type":"integer","format":"int32","default":0,"description":"It indicates the specific page to display (the counter starts from zero).","example":3},"example":3},{"name":"s","in":"query","description":"It indicates the number of items per page.","schema":{"type":"integer","format":"int32","default":0,"description":"It indicates the number of items per page.","example":25,"maximum":50},"example":25},{"name":"d","in":"query","description":"It indicates how the pages are ordered.","schema":{"$ref":"#/components/schemas/Direction"},"example":"DESC"},{"name":"props","in":"query","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.","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"}},"example":"creationTime"}],"responses":{"200":{"description":"The result is an array containing `TransactionCustomExport`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionCustomExports"}}}},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["transaction_read"]}]}},"/business/v2/wallets/autotransfer-presets":{"get":{"tags":["Auto-Transfer Presets"],"summary":"Search Auto-transfer Presets","description":"Endpoint to find `AutoTransferPreset` using filtering parameters.","operationId":"wallet-auto-transfer-presets-search","parameters":[{"name":"type","in":"query","description":"The type of `AutoTransferPreset`.","schema":{"type":"array","description":"The type of `AutoTransferPreset`.","items":{"$ref":"#/components/schemas/WalletPresetType"},"uniqueItems":true},"example":"WHEN_BALANCE_IS"},{"name":"currency","in":"query","schema":{"type":"array","description":"The currency of the `AutoTransferPreset`.","example":"The currency of the `AutoTransferPreset`.","items":{"type":"string","description":"The currency of the `AutoTransferPreset`.","example":"The currency of the `AutoTransferPreset`."},"uniqueItems":true}},{"name":"text","in":"query","description":"The full or partial name of the `AutoTransferPreset`.","schema":{"type":"string","description":"The full or partial name of the `AutoTransferPreset`.","example":"John Doe"},"example":"John Doe"},{"name":"p","in":"query","description":"It indicates the specific page to display (the counter starts from zero).","schema":{"type":"integer","format":"int32","default":0,"description":"It indicates the specific page to display (the counter starts from zero).","example":3},"example":3},{"name":"s","in":"query","description":"It indicates the number of items per page.","schema":{"type":"integer","format":"int32","default":0,"description":"It indicates the number of items per page.","example":25,"maximum":50},"example":25},{"name":"d","in":"query","description":"It indicates how the pages are ordered.","schema":{"$ref":"#/components/schemas/Direction"},"example":"DESC"},{"name":"props","in":"query","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.","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"}},"example":"creationTime"}],"responses":{"200":{"description":"The returned resource is an array containing `AutoTransferPresets`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WalletAutotransferPresets"}}}},"400":{"description":"Your request has missing arguments or is malformed."}},"security":[{"standardAuth":["wallet_read"]}]}},"/business/v2/cards/{cardId}/presets/{presetId}":{"put":{"tags":["Card Rules Presets"],"summary":"Add Preset to Card","description":"Endpoint to add a `CardRulePreset` to a `Card`.","operationId":"card-rule-preset-set","parameters":[{"name":"cardId","in":"path","description":"The `Card` ID","required":true,"schema":{"type":"string"},"example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},{"name":"presetId","in":"path","description":"The `CardRulePreset` ID","required":true,"schema":{"type":"string"},"example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"},{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Advanced authentication](ref:advanced-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","example":"{{fingerprint}}"}},{"name":"X-Soldo-Fingerprint-Signature","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint_signature}}","description":"[Advanced authentication](ref:advanced-authentication): Signature of the `X-Soldo-Fingerprint`.","example":"{{fingerprint_signature}}"}}],"responses":{"204":{"description":"No content as result."},"400":{"description":"Your request has missing arguments or is malformed."}},"security":[{"standardAuth":["card_write"]}],"x-soldo":{"fingerprint-order":"cardId, presetId, token"}},"delete":{"tags":["Card Rules Presets"],"summary":"Remove Preset from Card","description":"Endpoint to remove a `CardRulePreset` from a `Card`.","operationId":"card-rule-preset-unset","parameters":[{"name":"cardId","in":"path","description":"The `Card` ID.","required":true,"schema":{"type":"string"},"example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},{"name":"presetId","in":"path","description":"The `CardRulePreset` ID.","required":true,"schema":{"type":"string"},"example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"}],"responses":{"204":{"description":"No content as result."},"400":{"description":"Your request has missing arguments or is malformed."}},"security":[{"standardAuth":["card_write"]}]}},"/business/v2/transactions/{transactionId}/expense-category/{expenseCategoryId}":{"post":{"tags":["Transaction Expense Category"],"summary":"Add Expense Category to Transaction","description":"Endpoint to assign an `ExpenseCategory` to a `Transaction`.","operationId":"transaction-expense-category-set","parameters":[{"name":"transactionId","in":"path","required":true,"schema":{"type":"string","description":"The `Transaction` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}},{"name":"expenseCategoryId","in":"path","required":true,"schema":{"type":"string","description":"The `ExpenseCategory` ID.","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"}}],"responses":{"204":{"description":"No content as result."},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["transaction_write"]}]}},"/business/v2/transactions/{transactionId}/tax-rate/{taxRateId}":{"post":{"tags":["Transactions"],"summary":"Add VAT Rate to Transaction ","description":"Endpoint to assign a `VatRate` to a `Transaction`.","operationId":"transaction-tax-rate-set","parameters":[{"name":"transactionId","in":"path","required":true,"schema":{"type":"string","description":"The `Transaction` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}},{"name":"taxRateId","in":"path","required":true,"schema":{"type":"string","description":"The `VatRate` ID.","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"}}],"responses":{"204":{"description":"No content as result."},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["transaction_write"]}]}},"/business/v2/statements/download":{"post":{"tags":["Statements"],"summary":"Download Statement","description":"Endpoint to retrieve the presigned url to download a `Statement`.","operationId":"statement-download","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DownloadStatement"}}}},"responses":{"200":{"description":"The returned resource is a `Statement` presigned url.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatementDownloadUrl"}}}},"400":{"description":"Your request has missing arguments or is malformed."},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["statement_read"]}]}},"/business/v2/statements":{"get":{"tags":["Statements"],"summary":"Search Statements","description":"Endpoint to find `Statements` available for download using filtering parameters.","operationId":"statement-search","parameters":[{"name":"year","in":"query","description":"The year to search for `Statements`.","required":true,"schema":{"type":"array","description":"The year to search for `Statements`.","items":{"type":"integer","format":"int32","description":"The year to search for `Statements`."}},"example":2025},{"name":"currency","in":"query","description":"The [ISO 4217](https://www.six-group.com/en/products-services/financial-information/data-standards.html#scrollTo=maintenance-agency) code of the currency of the `Statement` to search for.","required":true,"schema":{"$ref":"#/components/schemas/ISO4217SupportedCurrency"},"example":"EUR"}],"responses":{"200":{"description":"The result array contains `Statements` available for download.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Statements"}}}},"400":{"description":"Your request has missing arguments or is malformed."}},"security":[{"standardAuth":["statement_read"]}]}},"/business/v2/transactions/{transactionId}":{"get":{"tags":["Transactions"],"summary":"Get Transaction","description":"Endpoint to get a specific `Transaction` by ID.","operationId":"transaction-get","parameters":[{"name":"transactionId","in":"path","description":"The `Transaction` ID.","required":true,"schema":{"type":"string","description":"The `Transaction` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},{"name":"showDetails","in":"query","description":"It determines whether to show further Details of the `Transaction`.","schema":{"type":"boolean","description":"It determines whether to show further Details of the `Transaction`.","example":false},"example":false},{"name":"showFuelDetails","in":"query","description":"It determines whether to show further Fuel Details of the `Transaction`.","schema":{"type":"boolean","description":"It determines whether to show further Fuel Details of the `Transaction`.","example":false},"example":false},{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Advanced authentication](ref:advanced-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","example":"{{fingerprint}}"}},{"name":"X-Soldo-Fingerprint-Signature","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint_signature}}","description":"[Advanced authentication](ref:advanced-authentication): Signature of the `X-Soldo-Fingerprint`.","example":"{{fingerprint_signature}}"}}],"responses":{"200":{"description":"The returned resource is a single `Transaction`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Transaction"}}}},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["transaction_read"]}],"x-soldo":{"fingerprint-order":"transactionId, token"}},"put":{"tags":["Transactions"],"summary":"Update Transaction","description":"Endpoint to update the assignee of a specific `Transaction` by ID. This method is only available for `Company` `Card` transactions and the `trx_owner_id` must be one of the `Card` assignees.","operationId":"transaction-update","parameters":[{"name":"transactionId","in":"path","required":true,"schema":{"type":"string","description":"The `Transaction` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}},{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Advanced authentication](ref:advanced-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","example":"{{fingerprint}}"}},{"name":"X-Soldo-Fingerprint-Signature","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint_signature}}","description":"[Advanced authentication](ref:advanced-authentication): Signature of the `X-Soldo-Fingerprint`.","example":"{{fingerprint_signature}}"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateTransaction"}}}},"responses":{"200":{"description":"The returned resource is a single `Transaction`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Transaction"}}}},"400":{"description":"Your request has missing arguments or is malformed."},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["transaction_write"]}],"x-soldo":{"fingerprint-order":"transactionId, userNotes, trxOwnerId, token"}}},"/business/v2/transactions":{"get":{"tags":["Transactions"],"summary":"Search Transactions","description":"Endpoint to find `Transactions` using filtering parameters.","operationId":"transaction-search","parameters":[{"name":"type","in":"query","description":"The resource `type` to be used together with id.","schema":{"$ref":"#/components/schemas/SearchTransactionResourceType"},"example":"card"},{"name":"hasAttachment","in":"query","description":"Looks whether or not a `TransactionAttachment` is present.","schema":{"type":"boolean","description":"Looks whether or not a `TransactionAttachment` is present.","example":true},"example":true},{"name":"publicId","in":"query","description":"The ID of the `type` resource.","schema":{"type":"string","description":"The ID of the `type` resource.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},{"name":"customreferenceId","in":"query","description":"The custom reference ID of the cardholder.","schema":{"type":"string","description":"The custom reference ID of the cardholder.","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"},"example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"},{"name":"fromDate","in":"query","description":"The beginning of the period of the search `fromDate` included (i.e. greater than or equal to) (Formats: `yyyy-MM-dd`, `yyyy-MM-ddThh:mm:ss`, `yyyy-MM-ddThh:mm:ssZ`).","schema":{"$ref":"#/components/schemas/DateParam"},"example":"1970-01-30"},{"name":"toDate","in":"query","description":"The end of the period of the search `toDate` included (i.e. less than) (Formats: `yyyy-MM-dd`, `yyyy-MM-ddThh:mm:ss`, `yyyy-MM-ddThh:mm:ssZ`).","schema":{"$ref":"#/components/schemas/DateParam"},"example":"1970-01-30"},{"name":"dateType","in":"query","description":"It determines the date to be considered for `fromDate` and `toDate` parameters.","schema":{"$ref":"#/components/schemas/SearchTransactionDateType"},"example":"TRANSACTION"},{"name":"groupId","in":"query","description":"The ID of the `Group` of the transactions.","schema":{"type":"string","description":"The ID of the `Group` of the transactions.","example":"c861cc24-6663-410f-8c78-73f886fff4ef"},"example":"c861cc24-6663-410f-8c78-73f886fff4ef"},{"name":"category","in":"query","description":"It determines the filter by category of the transaction, multiple categories can be included.","schema":{"type":"array","description":"It determines the filter by category of the transaction, multiple categories can be included.","items":{"$ref":"#/components/schemas/SearchTransactionCategory"}},"example":"Payment"},{"name":"status","in":"query","description":"It determines the filter by status of the transaction, multiple statuses can be included.","schema":{"type":"array","description":"It determines the filter by status of the transaction, multiple statuses can be included.","items":{"$ref":"#/components/schemas/TransactionStatus"}},"example":"Authorised"},{"name":"paymentMethod","in":"query","description":"It determines the filter by payment method of the transaction, multiple payment methods can be included. `OUT_OF_PLATFORM_COMPANY` and `OUT_OF_PLATFORM_PERSONAL` are not included by default.","schema":{"type":"array","description":"It determines the filter by payment method of the transaction, multiple payment methods can be included. `OUT_OF_PLATFORM_COMPANY` and `OUT_OF_PLATFORM_PERSONAL` are not included by default.","items":{"$ref":"#/components/schemas/SearchTransactionPaymentMethod"},"uniqueItems":true},"example":"SUBSCRIPTION"},{"name":"tagId","in":"query","description":"The ID of the `Tag` of the transaction.","schema":{"type":"string","description":"The ID of the `Tag` of the transaction.","example":"6853e657-c797-4985-8d6b-5425d4e51df8"},"example":"6853e657-c797-4985-8d6b-5425d4e51df8"},{"name":"metadataId","in":"query","description":"The ID of the custom generated `Metadata` of the `Transaction`.","deprecated":true,"schema":{"type":"string","deprecated":true,"description":"The ID of the custom generated `Metadata` of the `Transaction`.","example":"express"},"example":"express"},{"name":"text","in":"query","description":"A simple text to search in the transaction data (merchant, merchant category, user notes, tag, list, masked pan, card name, tx amount, vehicle plate, vehicle description).","schema":{"type":"string","description":"A simple text to search in the transaction data (merchant, merchant category, user notes, tag, list, masked pan, card name, tx amount, vehicle plate, vehicle description).","example":"Amazon"},"example":"Amazon"},{"name":"expenseType","in":"query","description":"The type of the expense.","schema":{"type":"array","description":"The type of the expense.","example":"TRAVEL_AND_ENTERTAINMENT","items":{"$ref":"#/components/schemas/ExpenseType"}},"example":"TRAVEL_AND_ENTERTAINMENT"},{"name":"expenseStatus","in":"query","schema":{"type":"array","description":"The status of the expense.","example":"APPROVED","items":{"$ref":"#/components/schemas/ExpenseStatus"}}},{"name":"expenseCategoryId","in":"query","schema":{"type":"array","description":"The ID of the Expense category of the transactions, multiple expense categories can be included.","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa","items":{"type":"string","description":"The ID of the Expense category of the transactions, multiple expense categories can be included.","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"},"uniqueItems":true}},{"name":"expenseReportId","in":"query","schema":{"type":"array","description":"The ID of the `ExpenseReport` of the transactions, multiple expense reports can be included.","example":"c861cc24-6663-410f-8c78-73f886fff4ef","items":{"type":"string","description":"The ID of the `ExpenseReport` of the transactions, multiple expense reports can be included.","example":"c861cc24-6663-410f-8c78-73f886fff4ef"}}},{"name":"exportStatus","in":"query","description":"The export status of the expense.","schema":{"$ref":"#/components/schemas/ExportStatus"},"example":"EXPORTED"},{"name":"taxRateId","in":"query","schema":{"type":"array","description":"The ID of the VAT rate of the transactions, multiple VAT rates can be included.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7","items":{"type":"string","description":"The ID of the VAT rate of the transactions, multiple VAT rates can be included.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}}},{"name":"requiredInformation","in":"query","description":"To search transactions with (or without) required information. A transaction is `COMPLETE` when all details marked as mandatory in the `Reminders` section have been filled in for the transaction.","schema":{"$ref":"#/components/schemas/SearchTransactionRequiredInformation"},"example":"COMPLETE"},{"name":"isSplit","in":"query","description":"Looks whether or not a transaction is split.","schema":{"type":"boolean","description":"Looks whether or not a transaction is split.","example":true},"example":true},{"name":"customExportedProduct","in":"query","description":"A product that exported list of `Transaction`","schema":{"type":"string","description":"A product that exported list of `Transaction`","example":"SAP"},"example":"SAP"},{"name":"customExported","in":"query","description":"Looks whether or not a `TransactionCustomExport` is present.","schema":{"type":"boolean","description":"Looks whether or not a `TransactionCustomExport` is present.","example":true},"example":true},{"name":"p","in":"query","description":"It indicates the specific page to display (the counter starts from zero).","schema":{"type":"integer","format":"int32","default":0,"description":"It indicates the specific page to display (the counter starts from zero).","example":3},"example":3},{"name":"s","in":"query","description":"It indicates the number of items per page.","schema":{"type":"integer","format":"int32","default":0,"description":"It indicates the number of items per page.","example":25,"maximum":50},"example":25},{"name":"d","in":"query","description":"It indicates how the pages are ordered.","schema":{"$ref":"#/components/schemas/Direction"},"example":"DESC"},{"name":"props","in":"query","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.","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"}},"example":"creationTime"},{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Advanced authentication](ref:advanced-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","example":"{{fingerprint}}"}},{"name":"X-Soldo-Fingerprint-Signature","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint_signature}}","description":"[Advanced authentication](ref:advanced-authentication): Signature of the `X-Soldo-Fingerprint`.","example":"{{fingerprint_signature}}"}}],"responses":{"200":{"description":"The result array contains `Transactions`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Transactions"}}}},"400":{"description":"Your request has missing arguments or is malformed."}},"security":[{"standardAuth":["transaction_read"]}],"x-soldo":{"fingerprint-order":"type, publicId, customReferenceId, groupId, fromDate, toDate, dateType, category, status, tagId, metadataId, text, expenseType, expenseStatus, requiredInformation, token"}}},"/business/v2/employees/{userId}/unassignRole":{"post":{"tags":["User Roles"],"summary":"Remove roles from User","description":"Endpoint to remove a `Role` from an `User`.","operationId":"user-role-unset","parameters":[{"name":"userId","in":"path","required":true,"schema":{"type":"string","description":"The `User` ID to remove `Role` from.","example":"XMPL1234-000001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUserRoleAssignment"}}}},"responses":{"200":{"description":"The returned resource is a single `User`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssignedUserRoles"}}}},"400":{"description":"Your request has missing arguments or is malformed."}},"security":[{"standardAuth":["employee_write"]}]}},"/business/v2/wallets/autotransfer-presets/{presetId}/unrelate-resource":{"put":{"tags":["Auto-Transfer Presets"],"summary":"Remove Wallets from Auto-transfer Preset","description":"Endpoint to remove a `Wallets` from a `AutoTransferPreset`.","operationId":"wallet-auto-transfer-preset-unset","parameters":[{"name":"presetId","in":"path","description":"The `AutoTransferPreset` ID","required":true,"schema":{"type":"string"},"example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WalletsToTransfer"}}}},"responses":{"204":{"description":"No content as result."},"400":{"description":"Your request has missing arguments or is malformed."}},"security":[{"standardAuth":["wallet_write"]}]}},"/business/v2/business-trips/{businessTripId}/details":{"put":{"tags":["Business Trips"],"summary":"Update BusinessTrip Details","description":"Endpoint to update the general details `BusinessTrip`.","operationId":"business-trip-update-details","parameters":[{"name":"businessTripId","in":"path","required":true,"schema":{"type":"string","description":"The `BusinessTrip` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}},{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Advanced authentication](ref:advanced-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","example":"{{fingerprint}}"}},{"name":"X-Soldo-Fingerprint-Signature","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint_signature}}","description":"[Advanced authentication](ref:advanced-authentication): Signature of the `X-Soldo-Fingerprint`.","example":"{{fingerprint_signature}}"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBusinessTripDetails"}}}},"responses":{"204":{"description":"No content as result."},"400":{"description":"Your request has missing arguments or is malformed."},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["business_trip_write"]}],"x-soldo":{"fingerprint-order":"request_timestamp,id,name"}}},"/business/v2/business-trips/{businessTripId}/expense-allocation":{"put":{"tags":["Business Trips"],"summary":"Update BusinessTrip Expense Allocation","description":"Endpoint to update allocation of expenses associated to a `BusinessTrip`.","operationId":"business-trip-update-expenses","parameters":[{"name":"businessTripId","in":"path","required":true,"schema":{"type":"string","description":"The `BusinessTrip` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}},{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Advanced authentication](ref:advanced-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","example":"{{fingerprint}}"}},{"name":"X-Soldo-Fingerprint-Signature","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint_signature}}","description":"[Advanced authentication](ref:advanced-authentication): Signature of the `X-Soldo-Fingerprint`.","example":"{{fingerprint_signature}}"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBusinessTripExpenseAllocation"}}}},"responses":{"204":{"description":"No content as result."},"400":{"description":"Your request has missing arguments or is malformed."},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["business_trip_write"]}],"x-soldo":{"fingerprint-order":"request_timestamp, id,join(concat(expense_allocation.spend_period,expense_allocation.amount,expense_allocation.amount_currency))"}}},"/business/v2/business-trips/{businessTripId}/post-actions":{"put":{"tags":["Business Trips"],"summary":"Update BusinessTrip Post Actions","description":"Endpoint to update actions to be executed after a `BusinessTrip`.","operationId":"business-trip-update-post-actions","parameters":[{"name":"businessTripId","in":"path","required":true,"schema":{"type":"string","description":"The `BusinessTrip` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBusinessTripPostActions"}}}},"responses":{"204":{"description":"No content as result."},"400":{"description":"Your request has missing arguments or is malformed."},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["business_trip_write"]}]}},"/business/v2/business-trips/{businessTripId}/tags":{"put":{"tags":["Business Trips"],"summary":"Update BusinessTrip Tags","description":"Endpoint to update tags associated to a `BusinessTrip`.","operationId":"business-trip-update-tags","parameters":[{"name":"businessTripId","in":"path","required":true,"schema":{"type":"string","description":"The `BusinessTrip` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBusinessTripTags"}}}},"responses":{"204":{"description":"No content as result."},"400":{"description":"Your request has missing arguments or is malformed."},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["business_trip_write"]}]}},"/business/v2/transactions/{transactionId}/expense-review/change-type":{"put":{"tags":["Expense Reviews"],"summary":"Update Expense Review Type","description":"Endpoint to update the type of an `ExpenseReview`.","operationId":"expense-review-update-type","parameters":[{"name":"transactionId","in":"path","required":true,"schema":{"type":"string","description":"The `Transaction` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateExpenseType"}}}},"responses":{"204":{"description":"No content as result."},"400":{"description":"Your request has missing arguments or is malformed."},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["expense_review_write"]}]}},"/business/v2/expense-review/processes/{processId}/status":{"put":{"tags":["Expense Review Processes"],"summary":"Update Expense Review Process Status","description":"Endpoint to update a specific `ExpenseReviewProcess` status.","operationId":"expense-review-process-status-update","parameters":[{"name":"processId","in":"path","required":true,"schema":{"type":"string","description":"The `ExpenseReviewProcess` ID.","example":" 2d9f6514-4004-4122-b7f2-dcf7e034741c"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateExpenseReviewProcessStatus"}}}},"responses":{"200":{"description":"The result is a single `ExpenseReviewProcess`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExpenseReviewProcess"}}}},"400":{"description":"Your request has missing arguments or is malformed."},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["expense_review_write"]}]}},"/business/v2/transactions/{transactionId}/expense-review/request-info":{"put":{"tags":["Expense Reviews"],"summary":"Request Expense Review Info","description":"Endpoint to request info to an `User` about an `ExpenseReview`.","operationId":"expense-review-request-info","parameters":[{"name":"transactionId","in":"path","required":true,"schema":{"type":"string","description":"The `Transaction` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestExpenseInfo"}}}},"responses":{"204":{"description":"No content as result."},"400":{"description":"Your request has missing arguments or is malformed."},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["expense_review_write"]}]}},"/business/v2/transactions/{transactionId}/expense-review/update-status":{"put":{"tags":["Expense Reviews"],"summary":"Update Expense Review Status","description":"Endpoint to update the status of an `ExpenseReview`.","operationId":"expense-review-update-status","parameters":[{"name":"transactionId","in":"path","required":true,"schema":{"type":"string","description":"The `Transaction` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateExpenseStatus"}}}},"responses":{"204":{"description":"No content as result."},"400":{"description":"Your request has missing arguments or is malformed."},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["expense_review_write"]}]}},"/business/v2/employees/{userId}/status":{"put":{"tags":["Users"],"summary":"Update User Status","description":"Endpoint to update an `User` status.","operationId":"user-status-update","parameters":[{"name":"userId","in":"path","required":true,"schema":{"type":"string","description":"The `User` ID.","example":"XMPL1234-000001"}},{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Advanced authentication](ref:advanced-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","example":"{{fingerprint}}"}},{"name":"X-Soldo-Fingerprint-Signature","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint_signature}}","description":"[Advanced authentication](ref:advanced-authentication): Signature of the `X-Soldo-Fingerprint`.","example":"{{fingerprint_signature}}"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUserStatus"}}}},"responses":{"200":{"description":"The returned result is a single `User`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}},"400":{"description":"Your request has missing arguments or is malformed."},"404":{"description":"One or more resource requested does not exist."}},"security":[{"standardAuth":["employee_write"]}],"x-soldo":{"fingerprint-order":"userId, status, token"}}},"/business/v2/webhooks/subscriptions/{webhookSubscriptionsId}":{"get":{"tags":["Webhook Subscriptions"],"summary":"Get Webhook Subscription","description":"Endpoint to retrieve a specific `WebhookSubscription` by ID.","operationId":"webhook-subscription-get","parameters":[{"name":"webhookSubscriptionsId","in":"path","required":true,"schema":{"type":"string","description":"The `WebhookSubscription` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}}],"responses":{"400":{"description":"Your request has missing arguments or is malformed."},"404":{"description":"One or more resource requested does not exist."},"default":{"description":"The returned resource is a single `WebhookSubscription`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookSubscription"}}}}},"security":[{"standardAuth":["webhook_subscription_read"]}]}},"/business/v2/ping/whoami":{"get":{"tags":["Authentication"],"summary":"Get who am I","description":"Endpoint to get information about the owner of the access token.","operationId":"who-am-i","responses":{"200":{"description":"The returned resource is a minimal representation of a `User`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WhoAmI"}}}}},"security":[{"standardAuth":["company_read"]}]}}},"components":{"schemas":{"OAuth2Token":{"properties":{"refresh_token":{"type":"string","description":"The token used to refresh the session (this operation is not currently supported).","example":"{{refresh_token}}"},"token_type":{"type":"string","description":"All requests must be always authenticated using the 'Bearer' scheme.","example":"Bearer"},"access_token":{"type":"string","description":"The bearer token to be included in all requests sent to our Business API as part of the `Authorization` header.","example":"{{access_token}}"},"expires_in":{"type":"string","description":"The `access_token` expiration, expressed in seconds. Once the `access_token` is expired your session will be invalidate, you will have to re-authenticate to get a fresh `access_token`.","example":7200}}},"Card":{"properties":{"id":{"type":"string","description":"The `Card` ID (sortable: yes).","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"name":{"type":"string","description":"The name of the `Card` (sortable: yes).","example":"CardName"},"label":{"type":"string","description":"The label of the `Card (sortable: no)`.","example":"CardLabel"},"masked_pan":{"type":"string","description":"The masked PAN of the `Card` (sortable: yes).","example":"123456******1234"},"card_holder":{"type":"string","description":"The name and surname of the Cardholder of the `Card`, only available when `owner_type` is `employee` (sortable: yes).","example":"John Doe"},"expiration_date":{"type":"string","description":"The expiration date and time of the `Card` (sortable: yes).","example":"2026-05-07T23:59:59Z"},"creation_time":{"type":"string","description":"The date and time when the `Card` was created (sortable: yes).","example":"2017-06-01T12:48:40Z"},"last_update":{"type":"string","description":"The date and time when the `Card` was last updated (sortable: yes).","example":"2017-06-01T12:48:40Z"},"type":{"$ref":"#/components/schemas/CardType","description":"The type of `Card` (sortable: no).","example":"PLASTIC"},"status":{"$ref":"#/components/schemas/CardStatus","description":"The status of the `Card` (sortable: yes).","example":"Normal"},"owner_type":{"$ref":"#/components/schemas/CardOwnerType","description":"The owner type (sortable: no).","example":"employee"},"owner_public_id":{"type":"string","description":"The ID of the Cardholder available when `owner_type` is `employee`.","example":"XMPL1234-000001"},"custom_reference_id":{"type":"string","description":"The custom reference ID of the Cardholder (sortable: no).","example":"123456-user-1"},"wallet_id":{"type":"string","description":"The ID of the `Wallet` the `Card` is linked to (sortable: no).","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"currency_code":{"$ref":"#/components/schemas/ISO4217Currency","description":"The currency of the `Wallet` the `Card` is linked to ([ISO 4217](https://www.six-group.com/en/products-services/financial-information/data-standards.html#scrollTo=maintenance-agency) code) (sortable: no).","example":"EUR"},"emboss_line4":{"type":"string","description":"The fourth line printed on the `Card` (sortable: no).","example":"Example Inc."},"active":{"type":"boolean","description":"It determines whether the `Card` is active (sortable: yes).","example":true},"group_id":{"type":"string","deprecated":true,"description":"The ID of the `Group` the `Card` is related to (sortable: no). In case of multiple groups associated this field contains the first one for backward compatibility.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"groups":{"type":"array","description":"The list of `Group` ID the `Card` is related to (sortable: no).","example":["7bf79328-a7ae-4222-aa54-091ff7f429a7","2d65bd5e-3fdf-4002-b166-bde7fb8863fa"],"items":{"type":"string"}},"sensitive_data":{"$ref":"#/components/schemas/CardSensitiveData","description":"The `Card` sensitive data (sortable: no)."},"vehicle_id":{"type":"string","description":"The ID of the `Vehicle` assigned to the card (sortable: no).","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"assignees":{"type":"array","description":"List of `User` IDs currently assigned to the `Card`, when `owner_type` is `employee` there is only one assignee, when is `company` there could be none or more assignees (sortable: no).","example":["XMPL1234-000001","XMPL1234-000002","XMPL1234-000003"],"items":{"type":"string"}},"payment_method":{"$ref":"#/components/schemas/CardPaymentMethod","description":"The `Card` payment method (sortable: no).","example":"ONLINE_ADS"},"payment_method_id":{"type":"string","description":"The payment method ID (sortable: no).","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"preset_id":{"type":"string","description":"The `cardRulePreset` ID assigned to the `Card`.","example":"c861cc24-6663-410f-8c78-73f886fff4ef"},"shipping_address_id":{"type":"string","description":"The `shippingAddress` ID assigned to the `Card`.","example":"c861cc24-6663-410f-8c78-73f886fff4ef"}}},"CardActivatedEvent":{"properties":{"event_uuid":{"type":"string","description":"The webhook unique ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"event_type":{"$ref":"#/components/schemas/WebhookEventType","default":"Card","description":"The webhook event type.","example":"Card"},"event_name":{"$ref":"#/components/schemas/WebhookEventName","default":"card_activated","description":"The webhook event name.","example":"card_activated"},"company_account_id":{"type":"string","description":"The company account ID.","example":"XMPL1234"},"data":{"$ref":"#/components/schemas/Card","description":"The webhook `Card` data."},"subscription_id":{"type":"string","description":"The webhook subscription ID used to route this event.","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"}}},"CardOwnerType":{"type":"string","enum":["company","employee"]},"CardPaymentMethod":{"type":"string","enum":["SUBSCRIPTION","ONLINE_ADS","PURCHASE"]},"CardSensitiveData":{"properties":{"encrypted_full_pan":{"type":"string","description":"The encrypted PAN of the card."},"encrypted_cvv":{"type":"string","description":"The encrypted cvv of the card."},"encrypted_pin":{"type":"string","description":"The encrypted pin of the card (only valid for PLASTIC or FUEL card type)."}}},"CardStatus":{"type":"string","enum":["Normal","Do not honor","Lost card","Stolen card","Expired card","Restricted card","Security Violation","Cardholder to contact the issuer","Card Destroyed"]},"CardType":{"type":"string","enum":["PLASTIC","VIRTUAL","FUEL","GOOGLE_CARD"]},"ISO4217Currency":{"type":"string","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]},"WebhookEventName":{"type":"string","enum":["card_activated","card_change_status","card_creation","card_destroyed","card_lost","card_replaced","card_stolen","card_label_updated","card_assignee_updated","add_resources_card","add_resources_member","add_resources_wallet","create_group","delete_group","move_resources_card","move_resources_member","move_resources_wallet","remove_resources_card","remove_resources_member","remove_resources_wallet","update_group","store_order_completed","store_order_placed","balanced_transfer","billing","card_authorization","conversion","customer_care_deposit","customer_care_withdraw","edit_tag","inbound_payment","inbound_payment_reversal","internal_transfer","joule_feed","load_failed","load_money","recurring_billing","scheduled_transfer","transaction_adjustment","unload_money","wiretransfer","upload_completed","attachment_delete","new_user","user_status_changed","user_updated","wallet_created","wallet_deleted","vehicle_create","vehicle_update","vehicle_delete","purchase_create","purchase_update","purchase_delete","purchase_redeem_card","created_expense_configuration","disabled_expense_configuration","enabled_expense_configuration","updated_expense_configuration","completed_transactions_import","updated_transaction","change_expense_type","subscription_activated","subscription_created","subscription_updated","subscription_deleted","subscription_assignee_added","subscription_assignee_removed","online_ads_activated","online_ads_created","online_ads_updated","online_ads_deleted","online_ads_assignee_added","online_ads_assignee_removed","transaction_created","transaction_modified","transaction_deleted"]},"WebhookEventType":{"type":"string","enum":["Card","ExpenseReview","Group","OnlineAds","Order","Purchase","Subscription","Transaction","TransactionAttachment","Employee","Vehicle","Wallet"]},"CardCreationEvent":{"properties":{"event_uuid":{"type":"string","description":"The webhook unique ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"event_type":{"$ref":"#/components/schemas/WebhookEventType","default":"Card","description":"The webhook event type.","example":"Card"},"event_name":{"$ref":"#/components/schemas/WebhookEventName","default":"card_creation","description":"The webhook event name.","example":"card_creation"},"company_account_id":{"type":"string","description":"The company account ID.","example":"XMPL1234"},"data":{"$ref":"#/components/schemas/Card","description":"The webhook `Card` data."},"subscription_id":{"type":"string","description":"The webhook subscription ID used to route this event.","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"}}},"CardChangeStatusEvent":{"properties":{"event_uuid":{"type":"string","description":"The webhook unique ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"event_type":{"$ref":"#/components/schemas/WebhookEventType","default":"Card","description":"The webhook event type.","example":"Card"},"event_name":{"$ref":"#/components/schemas/WebhookEventName","default":"card_change_status","description":"The webhook event name.","example":"card_change_status"},"company_account_id":{"type":"string","description":"The company account ID.","example":"XMPL1234"},"data":{"$ref":"#/components/schemas/Card","description":"The webhook `Card` data."},"subscription_id":{"type":"string","description":"The webhook subscription ID used to route this event.","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"}}},"CardDestroyedEvent":{"properties":{"event_uuid":{"type":"string","description":"The webhook unique ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"event_type":{"$ref":"#/components/schemas/WebhookEventType","default":"Card","description":"The webhook event type.","example":"Card"},"event_name":{"$ref":"#/components/schemas/WebhookEventName","default":"card_destroyed","description":"The webhook event name.","example":"card_destroyed"},"company_account_id":{"type":"string","description":"The company account ID.","example":"XMPL1234"},"data":{"$ref":"#/components/schemas/Card","description":"The webhook `Card` data."},"subscription_id":{"type":"string","description":"The webhook subscription ID used to route this event.","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"}}},"CardLostEvent":{"properties":{"event_uuid":{"type":"string","description":"The webhook unique ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"event_type":{"$ref":"#/components/schemas/WebhookEventType","default":"Card","description":"The webhook event type.","example":"Card"},"event_name":{"$ref":"#/components/schemas/WebhookEventName","default":"card_lost","description":"The webhook event name.","example":"card_lost"},"company_account_id":{"type":"string","description":"The company account ID.","example":"XMPL1234"},"data":{"$ref":"#/components/schemas/Card","description":"The webhook `Card` data."},"subscription_id":{"type":"string","description":"The webhook subscription ID used to route this event.","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"}}},"CardReplacedEvent":{"properties":{"event_uuid":{"type":"string","description":"The webhook unique ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"event_type":{"$ref":"#/components/schemas/WebhookEventType","default":"Card","description":"The webhook event type.","example":"Card"},"event_name":{"$ref":"#/components/schemas/WebhookEventName","default":"card_replaced","description":"The webhook event name.","example":"card_replaced"},"company_account_id":{"type":"string","description":"The company account ID.","example":"XMPL1234"},"data":{"$ref":"#/components/schemas/Card","description":"The webhook `Card` data."},"subscription_id":{"type":"string","description":"The webhook subscription ID used to route this event.","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"}}},"CardStolenEvent":{"properties":{"event_uuid":{"type":"string","description":"The webhook unique ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"event_type":{"$ref":"#/components/schemas/WebhookEventType","default":"Card","description":"The webhook event type.","example":"Card"},"event_name":{"$ref":"#/components/schemas/WebhookEventName","default":"card_stolen","description":"The webhook event name.","example":"card_stolen"},"company_account_id":{"type":"string","description":"The company account ID.","example":"XMPL1234"},"data":{"$ref":"#/components/schemas/Card","description":"The webhook `Card` data."},"subscription_id":{"type":"string","description":"The webhook subscription ID used to route this event.","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"}}},"CardLabelUpdatedEvent":{"properties":{"event_uuid":{"type":"string","description":"The webhook unique ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"event_type":{"$ref":"#/components/schemas/WebhookEventType","default":"Card","description":"The webhook event type.","example":"Card"},"event_name":{"$ref":"#/components/schemas/WebhookEventName","default":"card_label_updated","description":"The webhook event name.","example":"card_label_updated"},"company_account_id":{"type":"string","description":"The company account ID.","example":"XMPL1234"},"data":{"$ref":"#/components/schemas/Card","description":"The webhook `Card` data."},"subscription_id":{"type":"string","description":"The webhook subscription ID used to route this event.","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"}}},"CardAssigneeUpdatedEvent":{"properties":{"event_uuid":{"type":"string","description":"The webhook unique ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"event_type":{"$ref":"#/components/schemas/WebhookEventType","default":"Card","description":"The webhook event type.","example":"Card"},"event_name":{"$ref":"#/components/schemas/WebhookEventName","default":"card_assignee_updated","description":"The webhook event name.","example":"card_assignee_updated"},"company_account_id":{"type":"string","description":"The company account ID.","example":"XMPL1234"},"data":{"$ref":"#/components/schemas/Card","description":"The webhook `Card` data."},"subscription_id":{"type":"string","description":"The webhook subscription ID used to route this event.","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"}}},"AddResourcesCardEvent":{"properties":{"event_uuid":{"type":"string","description":"The webhook unique ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"event_type":{"$ref":"#/components/schemas/WebhookEventType","default":"Team","description":"The webhook event type.","example":"Team"},"event_name":{"$ref":"#/components/schemas/WebhookEventName","default":"add_resources_card","description":"The webhook event name.","example":"add_resources_card"},"company_account_id":{"type":"string","description":"The company account ID.","example":"XMPL1234"},"data":{"$ref":"#/components/schemas/Group","description":"The webhook `Group` data."},"subscription_id":{"type":"string","description":"The webhook subscription ID used to route this event.","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"}}},"Group":{"properties":{"id":{"type":"string","description":"The `Group` ID (sortable: yes).","example":"1bf79328-a7ae-4222-aa54-091ff7f429a7"},"name":{"type":"string","description":"The name of the `Group` (sortable: yes).","example":"HR"},"custom_reference_id":{"type":"string","description":"The `Group` reference in an external system.","example":"hr-division-0001"},"type":{"$ref":"#/components/schemas/GroupType","description":"The `Group` type (sortable: no).","example":"DIVISION"},"note":{"type":"string","description":"Any notes about the `Group` (sortable: no).","example":"division"},"members":{"type":"array","description":"A list of `User` IDs belonging to the `Group` (sortable: no).","example":["5bf79328-a7ae-4222-aa54-091ff7f429a7"],"items":{"type":"string"}},"wallets":{"type":"array","description":"A list of `Wallet` IDs related to the `Group` (sortable: no).","example":["4bf79328-a7ae-4222-aa54-091ff7f429a7"],"items":{"type":"string"}},"cards":{"type":"array","description":"A list of `Card` IDs related to the `Group` (sortable: no).","example":["3bf79328-a7ae-4222-aa54-091ff7f429a7"],"items":{"type":"string"}},"creation_time":{"type":"string","description":"The date and time when the `Group` was created (sortable: yes).","example":"2017-06-01T12:48:40Z"},"last_update":{"type":"string","description":"The date and time when the `Group` was last updated (sortable: yes).","example":"2017-06-30T12:48:40Z"}}},"GroupType":{"type":"string","enum":["TEAM","PROJECT","DEPARTMENT","DIVISION","SQUAD","UNIT","PRODUCTION"]},"AddResourcesMemberEvent":{"properties":{"event_uuid":{"type":"string","description":"The webhook unique ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"event_type":{"$ref":"#/components/schemas/WebhookEventType","default":"Team","description":"The webhook event type.","example":"Team"},"event_name":{"$ref":"#/components/schemas/WebhookEventName","default":"add_resources_member","description":"The webhook event name.","example":"add_resources_member"},"company_account_id":{"type":"string","description":"The company account ID.","example":"XMPL1234"},"data":{"$ref":"#/components/schemas/Group","description":"The webhook `Group` data."},"subscription_id":{"type":"string","description":"The webhook subscription ID used to route this event.","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"}}},"AddResourcesWalletEvent":{"properties":{"event_uuid":{"type":"string","description":"The webhook unique ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"event_type":{"$ref":"#/components/schemas/WebhookEventType","default":"Team","description":"The webhook event type.","example":"Team"},"event_name":{"$ref":"#/components/schemas/WebhookEventName","default":"add_resources_wallet","description":"The webhook event name.","example":"add_resources_wallet"},"company_account_id":{"type":"string","description":"The company account ID.","example":"XMPL1234"},"data":{"$ref":"#/components/schemas/Group","description":"The webhook `Group` data."},"subscription_id":{"type":"string","description":"The webhook subscription ID used to route this event.","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"}}},"CreateGroupEvent":{"properties":{"event_uuid":{"type":"string","description":"The webhook unique ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"event_type":{"$ref":"#/components/schemas/WebhookEventType","default":"Team","description":"The webhook event type.","example":"Team"},"event_name":{"$ref":"#/components/schemas/WebhookEventName","default":"create_group","description":"The webhook event name.","example":"create_group"},"company_account_id":{"type":"string","description":"The company account ID.","example":"XMPL1234"},"data":{"$ref":"#/components/schemas/Group","description":"The webhook `Group` data."},"subscription_id":{"type":"string","description":"The webhook subscription ID used to route this event.","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"}}},"DeleteGroupEvent":{"properties":{"event_uuid":{"type":"string","description":"The webhook unique ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"event_type":{"$ref":"#/components/schemas/WebhookEventType","default":"Team","description":"The webhook event type.","example":"Team"},"event_name":{"$ref":"#/components/schemas/WebhookEventName","default":"delete_group","description":"The webhook event name.","example":"delete_group"},"company_account_id":{"type":"string","description":"The company account ID.","example":"XMPL1234"},"data":{"$ref":"#/components/schemas/Group","description":"The webhook `Group` data."},"subscription_id":{"type":"string","description":"The webhook subscription ID used to route this event.","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"}}},"MoveResourcesCardEvent":{"properties":{"event_uuid":{"type":"string","description":"The webhook unique ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"event_type":{"$ref":"#/components/schemas/WebhookEventType","default":"Team","description":"The webhook event type.","example":"Team"},"event_name":{"$ref":"#/components/schemas/WebhookEventName","default":"move_resources_card","description":"The webhook event name.","example":"move_resources_card"},"company_account_id":{"type":"string","description":"The company account ID.","example":"XMPL1234"},"data":{"$ref":"#/components/schemas/Group","description":"The webhook `Group` data."},"subscription_id":{"type":"string","description":"The webhook subscription ID used to route this event.","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"}}},"MoveResourcesMemberEvent":{"properties":{"event_uuid":{"type":"string","description":"The webhook unique ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"event_type":{"$ref":"#/components/schemas/WebhookEventType","default":"Team","description":"The webhook event type.","example":"Team"},"event_name":{"$ref":"#/components/schemas/WebhookEventName","default":"move_resources_member","description":"The webhook event name.","example":"move_resources_member"},"company_account_id":{"type":"string","description":"The company account ID.","example":"XMPL1234"},"data":{"$ref":"#/components/schemas/Group","description":"The webhook `Group` data."},"subscription_id":{"type":"string","description":"The webhook subscription ID used to route this event.","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"}}},"MoveResourcesWalletEvent":{"properties":{"event_uuid":{"type":"string","description":"The webhook unique ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"event_type":{"$ref":"#/components/schemas/WebhookEventType","default":"Team","description":"The webhook event type.","example":"Team"},"event_name":{"$ref":"#/components/schemas/WebhookEventName","default":"move_resources_wallet","description":"The webhook event name.","example":"move_resources_wallet"},"company_account_id":{"type":"string","description":"The company account ID.","example":"XMPL1234"},"data":{"$ref":"#/components/schemas/Group","description":"The webhook `Group` data."},"subscription_id":{"type":"string","description":"The webhook subscription ID used to route this event.","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"}}},"RemoveResourcesCardEvent":{"properties":{"event_uuid":{"type":"string","description":"The webhook unique ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"event_type":{"$ref":"#/components/schemas/WebhookEventType","default":"Team","description":"The webhook event type.","example":"Team"},"event_name":{"$ref":"#/components/schemas/WebhookEventName","default":"remove_resources_card","description":"The webhook event name.","example":"remove_resources_card"},"company_account_id":{"type":"string","description":"The company account ID.","example":"XMPL1234"},"data":{"$ref":"#/components/schemas/Group","description":"The webhook `Group` data."},"subscription_id":{"type":"string","description":"The webhook subscription ID used to route this event.","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"}}},"RemoveResourcesMemberEvent":{"properties":{"event_uuid":{"type":"string","description":"The webhook unique ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"event_type":{"$ref":"#/components/schemas/WebhookEventType","default":"Team","description":"The webhook event type.","example":"Team"},"event_name":{"$ref":"#/components/schemas/WebhookEventName","default":"remove_resources_member","description":"The webhook event name.","example":"remove_resources_member"},"company_account_id":{"type":"string","description":"The company account ID.","example":"XMPL1234"},"data":{"$ref":"#/components/schemas/Group","description":"The webhook `Group` data."},"subscription_id":{"type":"string","description":"The webhook subscription ID used to route this event.","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"}}},"RemoveResourcesWalletEvent":{"properties":{"event_uuid":{"type":"string","description":"The webhook unique ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"event_type":{"$ref":"#/components/schemas/WebhookEventType","default":"Team","description":"The webhook event type.","example":"Team"},"event_name":{"$ref":"#/components/schemas/WebhookEventName","default":"remove_resources_wallet","description":"The webhook event name.","example":"remove_resources_wallet"},"company_account_id":{"type":"string","description":"The company account ID.","example":"XMPL1234"},"data":{"$ref":"#/components/schemas/Group","description":"The webhook `Group` data."},"subscription_id":{"type":"string","description":"The webhook subscription ID used to route this event.","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"}}},"UpdateGroupEvent":{"properties":{"event_uuid":{"type":"string","description":"The webhook unique ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"event_type":{"$ref":"#/components/schemas/WebhookEventType","default":"Team","description":"The webhook event type.","example":"Team"},"event_name":{"$ref":"#/components/schemas/WebhookEventName","default":"update_group","description":"The webhook event name.","example":"update_group"},"company_account_id":{"type":"string","description":"The company account ID.","example":"XMPL1234"},"data":{"$ref":"#/components/schemas/Group","description":"The webhook `Group` data."},"subscription_id":{"type":"string","description":"The webhook subscription ID used to route this event.","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"}}},"Order":{"properties":{"id":{"type":"string","description":"The `Order` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"status":{"$ref":"#/components/schemas/OrderStatus","description":"The status of the `Order`.","example":"PENDING"},"creation_time":{"type":"string","description":"The date and time when the `Order` was created.","example":"2017-06-01T12:48:40Z"},"last_update_time":{"type":"string","description":"The last update date of the `Order`.","example":"2017-06-01T12:48:40Z"},"error_code":{"type":"string","description":"In case is_valid is false, the error code of the `Order` is shown."},"total_paid_amount":{"type":"number","description":"The total amount of the `Order`.","example":10.25},"total_paid_currency":{"$ref":"#/components/schemas/ISO4217Currency","description":"The currency for the total paid amount.","example":"EUR"},"items":{"type":"array","description":"The products associated with the `Order`.","items":{"$ref":"#/components/schemas/OrderItem"}},"is_valid":{"type":"boolean","description":"It states whether the `Order` is valid.","example":true}}},"OrderItem":{"properties":{"id":{"type":"string","description":"The ID of a single item of a specific `Order`.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"item_type":{"type":"string","description":"The type of the ordered item.","example":"CARD"},"category":{"type":"string","description":"The category of the ordered item."}}},"OrderStatus":{"type":"string","description":"The status of the `Order`.","enum":["PENDING","ERROR","PLACED","CANCELLED","COMPLETED","COMPLETED_WITH_CREDIT"],"example":"PENDING"},"StoreOrderCompletedEvent":{"properties":{"event_uuid":{"type":"string","description":"The webhook unique ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"event_type":{"$ref":"#/components/schemas/WebhookEventType","default":"Order","description":"The webhook event type.","example":"Order"},"event_name":{"$ref":"#/components/schemas/WebhookEventName","default":"store_order_completed","description":"The webhook event name.","example":"store_order_completed"},"company_account_id":{"type":"string","description":"The company account ID.","example":"XMPL1234"},"data":{"$ref":"#/components/schemas/Order","description":"The webhook `Order` data."},"subscription_id":{"type":"string","description":"The webhook subscription ID used to route this event.","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"}}},"StoreOrderPlacedEvent":{"properties":{"event_uuid":{"type":"string","description":"The webhook unique ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"event_type":{"$ref":"#/components/schemas/WebhookEventType","default":"Order","description":"The webhook event type.","example":"Order"},"event_name":{"$ref":"#/components/schemas/WebhookEventName","default":"store_order_placed","description":"The webhook event name.","example":"store_order_placed"},"company_account_id":{"type":"string","description":"The company account ID.","example":"XMPL1234"},"data":{"$ref":"#/components/schemas/Order","description":"The webhook `Order` data."},"subscription_id":{"type":"string","description":"The webhook subscription ID used to route this event.","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"}}},"Address":{"properties":{"id":{"type":"string","description":"The `Address` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"recipient":{"type":"string","description":"The recipient of the `Address`","example":"JohnSmith"},"name":{"type":"string","description":"The actual name of the `Address`.","example":"Foo Street 75"},"line1":{"type":"string","description":"The `Address` street.","example":"Bar Street 64"},"line2":{"type":"string","description":"An optional other street.","example":"Other street 31"},"country":{"type":"string","description":"The country of the `Address`.","example":"GB"},"county":{"type":"string","description":"The county of the `Address`.","example":"LD"},"city":{"type":"string","description":"The city of the `Address`.","example":"London"},"post_code":{"type":"string","description":"The postal code of the `Address`.","example":"00000"},"delivery_phone_number":{"type":"string","description":"Delivery phone number","example":"+441234567890"},"default_shipping":{"type":"boolean","description":"True if the `Address` is the default shipping address.","example":false},"type":{"type":"string","description":"The type of the `Address`.","example":"SHIPPING"},"category":{"$ref":"#/components/schemas/AddressCategory","description":"The category of the `Address`.","example":"COMPANY"},"user_id":{"type":"string","description":"The `User` ID, only if category of the `Address` is `USER`."},"creation_time":{"type":"string","description":"The date and time when the `Address` was created.","example":"2017-06-01T12:48:40Z"},"last_update":{"type":"string","description":"The date and time when the `Address` was last updated.","example":"2017-06-01T12:48:40Z"}}},"AddressCategory":{"type":"string","enum":["USER","COMPANY"]},"BalancedTransferEvent":{"properties":{"event_uuid":{"type":"string","description":"The webhook unique ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"event_type":{"$ref":"#/components/schemas/WebhookEventType","default":"Transaction","description":"The webhook event type.","example":"Transaction"},"event_name":{"$ref":"#/components/schemas/WebhookEventName","default":"balanced_transfer","description":"The webhook event name.","example":"balanced_transfer"},"company_account_id":{"type":"string","description":"The company account ID.","example":"XMPL1234"},"data":{"$ref":"#/components/schemas/Transaction","description":"The webhook `Transaction` data."},"subscription_id":{"type":"string","description":"The webhook subscription ID used to route this event.","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"}}},"CustomExport":{"properties":{"product":{"type":"string","description":"A product that exported list of `Transaction`","example":"SAP"},"export_date":{"type":"string","description":"A date of exported `Transactions`","example":"2017-06-01T12:48:40Z"}}},"ExpenseCategory":{"properties":{"id":{"type":"string","description":"The `ExpenseCategory` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"code":{"type":"string","description":"The code of the `ExpenseCategory`.","example":123},"name":{"type":"string","description":"The name of the `ExpenseCategory`.","example":"category-one"},"description":{"type":"string","description":"A custom description of the `ExpenseCategory`.","example":"An expense category"},"tax_rate_id":{"type":"string","description":"The ID of the VAT rate linked to the `ExpenseCategory`.","example":"c861cc24-6663-410f-8c78-73f886fff4ef"},"enabled":{"type":"boolean","description":"The `ExpenseCategory` is visible in the transaction detail.","example":false},"merchant_categories":{"type":"array","description":"A list of merchant categories this `ExpenseCategory`.","items":{"$ref":"#/components/schemas/MerchantCategory"},"uniqueItems":true},"expense_type":{"type":"string","description":"The type of expense assigned to category.","example":"TRAVEL_AND_ENTERTAINMENT"},"integration":{"type":"string","description":"The `ExpenseCategory`'s correlated integration.","example":"Netsuite"},"creation_time":{"type":"string","description":"The date and time when the `ExpenseCategory` was created (sortable: no).","example":"2017-06-01T12:48:40Z"},"last_update_time":{"type":"string","description":"The date and time when the `ExpenseCategory` was last updated (sortable: no).","example":"2017-06-01T12:48:40Z"}}},"ExpenseStatus":{"type":"string","enum":["APPROVED","PARTIALLY_APPROVED","DENIED","TO_REVIEW"]},"ExpenseType":{"type":"string","enum":["COMPANY","PERSONAL","TRAVEL_AND_ENTERTAINMENT"]},"FuelType":{"type":"string","enum":["PETROL","DIESEL","METHANE","LPG","LNG","ELECTRIC","UNKNOWN"]},"ISO3166Country":{"type":"string","enum":["ASC","AND","ARE","AFG","ATG","AIA","ALB","ARM","ANT","AGO","ATA","ARG","ASM","AUT","AUS","ABW","ALA","AZE","BIH","BRB","BGD","BEL","BFA","BGR","BHR","BDI","BEN","BLM","BMU","BRN","BOL","BES","BRA","BHS","BTN","BUR","BVT","BWA","BLR","BLZ","CAN","CCK","COD","CAF","COG","CHE","CIV","COK","CHL","CMR","CHN","COL","CPT","CRI","CSXX","CUB","CPV","CUW","CXR","CYP","CZE","DEU","DGA","DJI","DNK","DMA","DOM","DZA","ECU","EST","EGY","ESH","ERI","ESP","ETH","FIN","FJI","FLK","FSM","FRO","FRA","FXX","GAB","GBR","GRD","GEO","GUF","GGY","GHA","GIB","GRL","GMB","GIN","GLP","GNQ","GRC","SGS","GTM","GUM","GNB","GUY","HKG","HMD","HND","HRV","HTI","HUN","IDN","IRL","ISR","IMN","IND","IOT","IRQ","IRN","ISL","ITA","JEY","JAM","JOR","JPN","KEN","KGZ","KHM","KIR","COM","KNA","PRK","KOR","KWT","CYM","KAZ","LAO","LBN","LCA","LIE","LKA","LBR","LSO","LTU","LUX","LVA","LBY","MAR","MCO","MDA","MNE","MAF","MDG","MHL","MKD","MLI","MMR","MNG","MAC","MNP","MTQ","MRT","MSR","MLT","MUS","MDV","MWI","MEX","MYS","MOZ","NAM","NCL","NER","NFK","NGA","NIC","NLD","NOR","NPL","NRU","NTZ","NIU","NZL","OMN","PAN","PER","PYF","PNG","PHL","PAK","POL","SPM","PCN","PRI","PSE","PRT","PLW","PRY","QAT","REU","ROU","ROM","SRB","RUS","RWA","SAU","SLB","SYC","SDN","SWE","SGP","SHN","SVN","SJM","SVK","SLE","SMR","SEN","SOM","SUR","SSD","STP","SUN","SLV","SXM","SYR","SWZ","TAA","TCA","TCD","ATF","TGO","THA","TJK","TKL","TLS","TKM","TUN","TON","TUR","TTO","TUV","TWN","TZA","UKR","UGA","UMI","USA","URY","UZB","VAT","VCT","VEN","VGB","VIR","VNM","VUT","WLF","WSM","XKX","XXK","YEM","MYT","YUCS","ZAF","ZMB","ZRCD","ZWE"]},"Invoice":{"properties":{"number":{"type":"string","description":"A unique identifier assigned to an invoice by the supplier.","example":"INV-2023-001","maxLength":50,"pattern":"^(?![=+\\-@])[^,;'\"]{0,50}$"},"date":{"type":"string","description":"The date the invoice was issued by the supplier. Accepted format: yyyy-MM-dd.","example":"2023-01-23"},"po_number":{"type":"string","description":"A reference number provided by the customer's purchasing system (Purchase Order Number)","example":"PO-2023-001","maxLength":50,"pattern":"^(?![=+\\-@])[^,;'\"]{0,50}$"},"supplier_vat_number":{"type":"string","description":"The Value-Added Tax (VAT) registration number of the supplier.","example":123456789,"maxLength":15,"pattern":"^[a-zA-Z0-9]{0,15}$"}}},"LoadSource":{"type":"string","enum":["UNSPECIFIED","BANK_TRANSFER","CARD","SISAL_PAY","FASTER_PAYMENT"]},"MerchantCategory":{"type":"string","enum":["Advertising","Entertainment","Utilities","Food_Cocktail_Bar","Food_Restaurant","Food_Store","Food_Wine","Services_Business","Services_Cleaning","Services_Contracted","Services_Delivery","Services_Educational","Services_Financial","Services_Gambling","Services_Government","Services_Health","Services_Insurance","Services_Legal","Services_Museum","Services_Organisation","Services_Personal","Services_Repair","Services_Social","Services_Stationery","Services_Telecommunication","Services_Veterinary","Services_Warehouse","Services_Wholesale","Shopping_Accessories","Shopping_Airline","Shopping_Art","Shopping_Automotive","Shopping_Beauty","Shopping_Books","Shopping_Clothes","Shopping_Digital_Goods","Shopping_Direct_Marketing","Shopping_Furnitures","Shopping_Sport","Shopping_Store","Shopping_Technology","Transport_Airports","Transport_Charging_Station","Transport_Parking","Transport_Public_Transportation","Transport_Road","Transport_Service_Station","Transport_Ships","Transport_Taxi","Transport_Toll_Roads","Transport_Trains","Travel_Airlines","Travel_Agency","Travel_Car_Rental","Travel_Hotels","Travel_Time_Shares"]},"SearchTransactionRequiredInformation":{"type":"string","enum":["COMPLETE","NOT_COMPLETE"]},"Source":{"properties":{"name":{"type":"string","description":"The source name.","example":"J. Doe"},"type":{"$ref":"#/components/schemas/LoadSource","description":"The source type.","example":"BANK_TRANSFER"},"destination_wallet_id":{"type":"string","description":" The receiving wallet in the transaction, to which funds are being transferred.","example":"de29bffb-7da2-40f1-934a-241170762d3e"},"destination_wallet_name":{"type":"string","description":" The receiving wallet name in the transaction, to which funds are being transferred.","example":"EURO VIBAN"}}},"Transaction":{"properties":{"id":{"type":"string","description":"The `Transaction` ID (sortable: yes).","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"wallet_id":{"type":"string","description":"The ID of the `Wallet` from where the `Transaction` has been authorised (sortable: no).","example":"6853e657-c797-4985-8d6b-5425d4e51df8"},"wallet_name":{"type":"string","description":"The name of the `Wallet` from where the `Transaction` has been authorised (sortable: no).","example":"John Doe"},"status":{"$ref":"#/components/schemas/TransactionStatus","description":"The status of the `Transaction` (sortable: yes).","example":"Settled"},"category":{"$ref":"#/components/schemas/TransactionCategory","description":"The category of the `Transaction` (sortable: yes).","example":"Payment"},"transaction_sign":{"$ref":"#/components/schemas/TransactionSign","description":"The sign of the transaction amount (Negative, Positive, None) (sortable: no).","example":"Negative"},"purchase_id":{"type":"string","description":"The `Purchase` ID (sortable: no).","example":"6853e657-c797-4985-8d6b-5425d4e51df8"},"amount":{"type":"number","description":"The amount of the `Transaction` in the currency of the `Wallet` (sortable: no).","example":10.25},"amount_currency":{"$ref":"#/components/schemas/ISO4217Currency","description":"The currency [ISO 4217](https://www.six-group.com/en/products-services/financial-information/data-standards.html#scrollTo=maintenance-agency) code of the amount (sortable: no).","example":"EUR"},"tx_amount":{"type":"number","description":"The amount of the `Transaction` in the currency of the `Merchant` (sortable: no).","example":10.25},"tx_amount_currency":{"$ref":"#/components/schemas/ISO4217Currency","description":"The currency [ISO 4217](https://www.six-group.com/en/products-services/financial-information/data-standards.html#scrollTo=maintenance-agency) code of the `tx_amount` (sortable: no).","example":"EUR"},"fee_amount":{"type":"number","description":"The amount of the `Transaction` fee in the currency of the `Wallet` (sortable: no).","example":10.25},"fee_currency":{"$ref":"#/components/schemas/ISO4217Currency","description":"The currency [ISO 4217](https://www.six-group.com/en/products-services/financial-information/data-standards.html#scrollTo=maintenance-agency) code of the fee_amount (sortable: no).","example":"EUR"},"exchange_rate":{"type":"number","description":"The exchange rate applied at the `Settled` status (sortable: no).","example":1},"auth_exchange_rate":{"type":"number","description":"The exchange rate applied at the `Authorised` status (sortable: no).","example":1},"expense_status":{"$ref":"#/components/schemas/ExpenseStatus","description":"The status of approval of the expense (sortable: no).","example":"APPROVED"},"expense_type":{"$ref":"#/components/schemas/ExpenseType","description":"The type of the expense (sortable: no).","example":"TRAVEL_AND_ENTERTAINMENT"},"expense_date":{"type":"string","description":"The date and time of the last review of the expense (sortable: no).","example":"2017-06-01T12:48:40Z"},"expense_reviewer":{"type":"string","description":"The ID of the `User` who reviewed the expense (sortable: no).","example":"XMPL1234-000001"},"expense_approved_amount":{"type":"number","description":"The expense amount that a reviewer has approved (sortable: no).","example":10.25},"expense_report_id":{"type":"string","description":"The ID of the `ExpenseReport` the `Transaction` is included into (sortable: no).","example":"c861cc24-6663-410f-8c78-73f886fff4ef"},"date":{"type":"string","description":"The date and time of the `Transaction` at the `Authorised` status (sortable: yes).","example":"2017-06-01T12:48:40Z"},"settlement_date":{"type":"string","description":"The date and time of the `Transaction` at the `Settled` status (sortable: yes).","example":"2017-06-01T12:48:40Z"},"update_time":{"type":"string","description":"The date and time of the last update to the `Transaction` (sortable: yes).","example":"2017-06-01T12:48:40Z"},"merchant":{"$ref":"#/components/schemas/TransactionMerchant","description":"The name of the Merchant of the transaction (only valid for `Payment`, `Withdrawal`, `Refund` transaction categories) (sortable: no)."},"merchant_category":{"$ref":"#/components/schemas/TransactionMerchantCategory","description":"The category of the `Merchant` of the `Transaction` (only valid for `Payment`, `Withdrawal`, `Refund` transaction categories) (sortable: no)."},"tags":{"type":"array","description":"The list of the `Tags` of the `Transaction`.","items":{"$ref":"#/components/schemas/TransactionTag"}},"card_id":{"type":"string","description":"The ID of the `Card` used for the `Transaction` (sortable: no).","example":"6853e657-c797-4985-8d6b-5425d4e51df8"},"masked_pan":{"type":"string","description":"The masked PAN of the `Card` used for the `Transaction` (sortable: yes).","example":"123456******1234"},"owner_name":{"type":"string","description":"The name of the cardholder who made the transaction (only available when `owner_type` is `employee`) (sortable: no).","example":"John"},"owner_surname":{"type":"string","description":"The surname of the cardholder who made the transaction (only available when `owner_type` is `employee`) (sortable: no).","example":"Smith"},"owner_type":{"$ref":"#/components/schemas/TransactionOwnerType","description":"The owner type (`company`, `employee`) (sortable: no).","example":"company"},"owner_id":{"type":"string","description":"The ID of the Cardholder who made the `Transaction` (only available when `owner_type` is `employee`) (sortable: no).","example":"XMPL1234-000003"},"custom_reference_id":{"type":"string","description":"The custom reference ID of the Cardholder who made the `Transaction` (only available when `owner_type` is `employee`) (sortable: no).","example":"123456-user-1"},"group_id":{"type":"string","description":"The ID of the `Group` the `Transaction` belongs to (sortable: no). ","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"},"has_attachments":{"type":"boolean","description":"It determines whether the transaction has one or more `TransactionAttachments` (sortable: no).","example":false},"trx_owner_id":{"type":"string","description":"For User `Card` transactions, when `owner_type` is `employee`, is the cardholder ID, for Company `Card`, when `owner_type` is `company`, is empty or one of the `Card` assignees (sortable: no).","example":"XMPL1234-000003"},"metadata_ids":{"type":"array","description":"A list of IDs related to custom generated `Metadata` of the `Transaction` (sortable: no).","example":["express"],"items":{"type":"string"}},"fuel_details":{"$ref":"#/components/schemas/TransactionFuelDetails","description":"The fuel details of the `Transaction`  (sortable: no)."},"vat_percentage":{"type":"number","description":"The VAT percentage applied (sortable: no).","example":15},"vat_amount":{"type":"number","description":"The amount of the VAT in the currency of the `Wallet` (sortable: no).","example":10.25},"vat_currency":{"$ref":"#/components/schemas/ISO4217Currency","description":"The currency [ISO 4217](https://www.six-group.com/en/products-services/financial-information/data-standards.html#scrollTo=maintenance-agency) code of the vat_amount (sortable: no).","example":"EUR"},"user_notes":{"type":"string","description":"The notes defined by the `User` (sortable: no)."},"notes":{"type":"string","description":"The notes defined by Soldo (sortable: no)."},"direct_url":{"type":"string","description":"The direct URL to the transaction details page (sortable: no)."},"flags":{"type":"array","description":"List of strings: `forUser`, `forAdmin` or empty. It determines for which kinds of `Users` the transaction is flagged to (sortable: no).","example":["forUser"],"items":{"type":"string"}},"payment_method":{"$ref":"#/components/schemas/TransactionPaymentMethod","description":"The payment method of the `Transaction`.","example":"ONLINE_ADS"},"payment_method_id":{"type":"string","description":"The ID of the payment method, could be the ID of a `Subscription`, `OnlineAds` or `Purchase` resource (sortable: no).","example":"6853e657-c797-4985-8d6b-5425d4e51df8"},"expense_category":{"$ref":"#/components/schemas/ExpenseCategory","description":"The `ExpenseCategory` assigned to the `Transaction`."},"tax_rate":{"$ref":"#/components/schemas/VatRate","description":"The `Transaction`'s `VatRate`."},"split":{"type":"boolean","description":"It determines whether the transaction has been split (sortable: no).","example":false},"tx_id":{"type":"string","description":"The transaction's internal id (the same ID that can be found on reports and the advanced details section of a `Transaction`).","example":"5-857211147-150603333585014265"},"payment_trn_code":{"type":"string","description":"The Transaction Reference Number (TRN) of the outbound payment generated by Soldo. Available for `SEPA`, `SEPA_INSTANT`.","example":"1234567890123456789012345678IT"},"carbon_emissions":{"$ref":"#/components/schemas/TransactionCarbonEmissionInfo","description":"The amount of CO2e emissions generated as a result of the `Transaction`."},"required_information":{"$ref":"#/components/schemas/SearchTransactionRequiredInformation","description":"It indicates whether a transaction has (or doesn’t have) all details marked as mandatory in the ‘Reminders’ section filled in.","example":"COMPLETE"},"reimbursement_expense_report_id":{"type":"string","description":"The ID of the ExpenseReport that was reimbursed by this payment. Note to developer: if this ID is not null this payment can be considered a reimbursement. (sortable: no)."},"invoice":{"$ref":"#/components/schemas/Invoice","description":"The invoice to which this transaction relates"},"source":{"$ref":"#/components/schemas/Source","description":"Info about the origin of the `Transaction` (this applies for `InboundFasterPayment`, `InboundFasterPaymentReversal`, `Load`, `LoadReversal` and `Wiretransfer`)."},"custom_export":{"type":"array","description":"The info generated as a result of the custom export `Transaction`.","items":{"$ref":"#/components/schemas/CustomExport"}},"out_spending_policy":{"$ref":"#/components/schemas/TransactionSpendingPolicyMetadata","description":"The outSpendingPolicy of the `Transaction`."},"card_name":{"type":"string","description":"The name of the `Card` used for the `Transaction` (sortable: no).","example":"CardName"},"details":{"$ref":"#/components/schemas/TransactionDetails","description":"The details of the `Transaction`  (sortable: no)."},"split_transactions":{"type":"array","description":"The list of `SplitTransactionInfo`.","items":{"$ref":"#/components/schemas/TransactionSplitInfo"}},"timeline":{"type":"array","description":"The timeline of changes affecting the `Transaction` and the related `Wallet`. For each occurrence, the `Wallet` balance is reported before and after the change.","items":{"$ref":"#/components/schemas/TransactionTimelineItem"}}}},"TransactionAmount":{"properties":{"amount":{"type":"number","description":"The amount of the `Transaction` line.","example":10.25},"currency":{"$ref":"#/components/schemas/ISO4217Currency","description":"The currency [ISO 4217](https://www.six-group.com/en/products-services/financial-information/data-standards.html#scrollTo=maintenance-agency) code of the amount.","example":"EUR"}}},"TransactionCarbonEmissionInfo":{"properties":{"value":{"type":"number","description":"The amount of greenhouses gas emissions generated."},"unit":{"type":"string","description":"The unit of measure related to the `value` of greenhouses gas emissions generated."}}},"TransactionCategory":{"type":"string","enum":["Billing","Chargeback","Conversion","Fee","FeeReversal","InboundFasterPayment","InboundFasterPaymentReversal","Load","LoadReversal","MileageReimbursement","NotRecognized","P2P","Payment","Rebalance","RecurringBilling","Refund","SoldoActivity","SoldoCreditOperation","SoldoDebitOperation","Transfer","Wiretransfer","Withdrawal"]},"TransactionDetails":{"properties":{"de022":{"type":"string","description":"Mastercard `DE022` field."},"de061":{"type":"string","description":"Mastercard `DE061` field."},"tx_country":{"$ref":"#/components/schemas/ISO3166Country","description":"The [ISO 3166-1 alpha-3](https://www.iso.org/obp/ui/#search/code/) code of the country where the `Transaction` has been authorised.","example":"GBR"},"denied_info_type":{"type":"string","description":"The type of the denied reason of the transaction (only if the `Transaction` is `Declined`)."},"denied_info_description":{"type":"string","description":"The description of the denied reason (only if the `Transaction` is `Declined`)."},"is_card_present":{"type":"boolean","description":"It determines whether the card was there at the moment of the `Transaction`.","example":false},"is_atm_transaction":{"type":"boolean","description":"It determines whether the transaction is an ATM withdrawal.","example":false}}},"TransactionFuelDetails":{"description":"The transaction fuel details `Refueling` resource","properties":{"plate":{"type":"string","description":"`Vehicle`'s plate number.","example":"AA000BB"},"vehicle_fuel_type":{"$ref":"#/components/schemas/FuelType","description":"Fuel type specified in the `Vehicle`'s configuration page.","example":"PETROL"},"vat_deductibility_percentage":{"type":"string","description":"The deductible VAT percentage configured for the `Vehicle`.","example":"40%"},"mileage":{"type":"integer","format":"int32","description":"The `Vehicle` mileage.","example":125000},"quantity":{"type":"number","description":"The fuel quantity as specified in the invoice.","example":80},"unit_price":{"type":"number","description":"The fuel unit price as specified on the transaction.","example":1.41},"tx_fuel_type":{"$ref":"#/components/schemas/FuelType","description":"The fuel type as specified on the transaction.","example":"PETROL"},"to_be_ignored":{"type":"boolean","description":"If the transaction link status is set to ignored.","example":false},"invoice_id":{"type":"integer","format":"int64","description":"Invoice ID.","example":4421109},"invoice_number":{"type":"string","description":"Invoice number.","example":"NVC112200987"},"invoice_date":{"type":"string","description":"Invoice date.","example":"2017-06-01T12:48:40Z"},"invoice_total_amount":{"type":"number","description":"Total amount of the linked invoice.","example":10.25},"invoice_row":{"type":"integer","format":"int32","description":"Row of the linked invoice.","example":4},"invoice_row_amount":{"type":"number","description":"Amount of the transaction's row in the linked invoice.","example":10.25},"supplier_vat_id":{"type":"string","description":"Supplier VAT ID.","example":98746784967},"dri":{"type":"string","description":"The DRI (Documento Riepilogativo) code.","example":"DRI00099881"},"vehicle_id":{"type":"string","description":"The `Vehicle` ID.","example":"6853e657-c797-4985-8d6b-5425d4e51df8"}}},"TransactionMerchant":{"properties":{"id":{"type":"string","description":"The ID of the `Merchant`.","example":2100846839},"name":{"type":"string","description":"The name of the `Merchant` (normalised).","example":"SHH HOTEL LONDON"},"raw_name":{"type":"string","description":"The raw name of the `Merchant`.","example":"SHERLOCK HOLMES HOTEL  LONDON        GBR"},"code":{"type":"string","description":"The Mastercard `Merchant` code."},"address":{"type":"string","description":"The `Merchant` address."}}},"TransactionMerchantCategory":{"properties":{"description":{"type":"string","description":"The merchant category description as defined in the Soldo platform.","example":"Travel"},"mcc":{"type":"string","description":"The official Mastercard Merchant Category Code (MCC).","example":7011},"mcc_description":{"type":"string","description":"The official Mastercard Merchant category description.","example":"Lodging - Hotels, Motels, Resorts - not elsewhere classified"},"code":{"type":"string","deprecated":true,"description":"The merchant category code as defined in the Soldo platform. *Deprecated*: use `description` instead.","example":"Lodging - Hotels, Motels, Resorts - not elsewhere classified"},"sub_category":{"type":"string","description":"The merchant sub-category as defined in the Soldo platform.","example":"Hotels"}}},"TransactionOwnerType":{"type":"string","enum":["employee","company"]},"TransactionPaymentMethod":{"type":"string","enum":["USER","COMPANY","PURCHASE","SUBSCRIPTION","ONLINE_ADS","OUT_OF_PLATFORM_COMPANY","OUT_OF_PLATFORM_PERSONAL","WIRETRANSFER"]},"TransactionSign":{"type":"string","enum":["Negative","Positive","None"]},"TransactionSpendingPolicyMetadata":{"properties":{"approved_amount":{"$ref":"#/components/schemas/TransactionAmount","description":"The `Transaction` amount approved in policy."},"rejected_amount":{"$ref":"#/components/schemas/TransactionAmount","description":"The `Transaction` amount rejected in policy."}}},"TransactionSplitInfo":{"properties":{"amount":{"$ref":"#/components/schemas/TransactionAmount","description":"The `Transaction`'s line amount."},"vat_amount":{"$ref":"#/components/schemas/TransactionAmount","description":"The `Transaction`'s line VAT amount."},"expense_type":{"$ref":"#/components/schemas/ExpenseType","description":"The type of the expense.","example":"TRAVEL_AND_ENTERTAINMENT"},"line_number":{"type":"integer","format":"int32","description":"The `Transaction`'s line number.","example":1},"tags":{"type":"array","description":"The list of the Tags of the Transaction (only returned from [Get Transaction](https://developer.soldo.com/reference/transaction-get)).","items":{"$ref":"#/components/schemas/TransactionSplitInfoTag"}},"employee":{"$ref":"#/components/schemas/User","description":"The `User` which the transaction line is assigned to."},"expense_category":{"$ref":"#/components/schemas/ExpenseCategory","description":"The `ExpenseCategory` object."},"tax_rate":{"$ref":"#/components/schemas/VatRate","description":"The `VATRate` object."},"approved_amount":{"$ref":"#/components/schemas/TransactionAmount","description":"The `TransactionList`'s line amount approved in policy."},"rejected_amount":{"$ref":"#/components/schemas/TransactionAmount","description":"The `TransactionList`'s line amount rejected in policy."}}},"TransactionSplitInfoTag":{"properties":{"id":{"type":"string","description":"The `Tag` ID.","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"},"dictionary_id":{"type":"string","description":"The `List` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"dictionary":{"type":"string","description":"The name of the `List` where the `Tag` is listed.","example":"ExampleTagDictionary"},"tag":{"type":"string","description":"The name of the `Tag`.","example":"tx-label"},"code":{"type":"string","description":"The code of the `Tag`.","example":"CODE tag"},"visible":{"type":"boolean","description":"It determines whether the `Tag` is visible in the `Transaction` detail.","example":true},"description":{"type":"string","description":"The description of the `Tag`.","example":"Label to mark transactions"}}},"TransactionStatus":{"type":"string","enum":["Authorised","Settled","Cancelled","Declined","DisputeFailed","DisputeOpened","DisputeWon","Moved","Unknown"]},"TransactionTag":{"properties":{"id":{"type":"string","description":"The `Tag` ID.","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"},"dictionary_id":{"type":"string","description":"The `List` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"dictionary":{"type":"string","description":"The name of the `List` where the `Tag` is listed.","example":"ExampleTagDictionary"},"tag":{"type":"string","description":"The name of the `Tag`.","example":"tx-label"},"code":{"type":"string","description":"The code of the `Tag`.","example":"CODE tag"},"visible":{"type":"boolean","description":"It determines whether the `Tag` is visible in the `Transaction` detail.","example":true},"description":{"type":"string","description":"The description of the `Tag`.","example":"Label to mark transactions"}}},"TransactionTimelineBalance":{"properties":{"available_amount":{"type":"number","description":"The `Wallet` available amount in the currency of the `Wallet`.","example":10.25},"pending_amount":{"type":"number","description":"The `Wallet` pending amount in the currency of the `Wallet`. This is also known as `blocked` amount.","example":10.25},"ledger_amount":{"type":"number","description":"The `Wallet` ledger amount in the currency of the `Wallet`. This is a shorthand for the sum of available and pending amounts.","example":10.25}}},"TransactionTimelineItem":{"properties":{"created_at":{"type":"string","description":"The instant the change happened to the `Transaction` and related `Wallet`.","example":"2017-06-01T12:48:40Z"},"status":{"$ref":"#/components/schemas/TransactionTimelineStatus","description":"What happened in that moment to the `Transaction` and to the related `Wallet`.","example":"Settled"},"amount":{"type":"number","description":"The amount related to the change in the currency of the `Wallet`.","example":10.25},"balance_after":{"$ref":"#/components/schemas/TransactionTimelineBalance","description":"The `Wallet` balance after the change took place.","example":10.25},"balance_before":{"$ref":"#/components/schemas/TransactionTimelineBalance","description":"The `Wallet` balance before the change took place.","example":10.25},"is_fee":{"type":"boolean","description":"Indicate whether the change is a fee.","example":true}}},"TransactionTimelineStatus":{"type":"string","enum":["Unspecified","Authorized","Reversed","Refunded","Settled","Withdraw","Deposit","Chargeback"]},"User":{"properties":{"id":{"type":"string","description":"The `User` ID.","example":"XMPL1234-000001"},"name":{"type":"string","description":"The name of the `User` (sortable: yes).","example":"John"},"surname":{"type":"string","description":"The surname of the `User` (sortable: yes).","example":"Smith"},"middlename":{"type":"string","description":"The middlename of the `User` (sortable: no).","example":"John"},"dob":{"type":"string","description":"The Date of birth of the `User`.","example":"1970-10-21"},"job_title":{"type":"string","description":"The job title of the `User` (sortable: yes).","example":"Business Strategist"},"department":{"type":"string","description":"The department of the `User` (sortable: no).","example":"Research & Development"},"email":{"type":"string","description":"The email address of the `User` (sortable: no).","example":"jdoe@fake.soldo.com"},"mobile":{"type":"string","description":"The mobile number of the `User` including the country code (sortable: no).","example":"+44123323232"},"mobile_prefix":{"type":"string","description":"The mobile number country code (sortable: no).","example":"+44"},"custom_reference_id":{"type":"string","description":"The reference of the employee in an external system (sortable: yes).","example":"123456-user-1"},"status":{"$ref":"#/components/schemas/UserStatus","description":"The status of the `User` (sortable: yes).","example":"ACTIVE"},"visible":{"type":"boolean","description":"It determines whether the `User` is visible in the web console (sortable: yes).","example":true},"mobile_access":{"type":"boolean","description":"It determines whether the `User` has mobile access (sortable: no).","example":true},"web_access":{"type":"boolean","description":"It determines whether the `User` has web access (sortable: no).","example":true},"groups":{"type":"array","description":"The list of `Groups` ID the `User` is member of (sortable: no).","example":["7bf79328-a7ae-4222-aa54-091ff7f429a7","2d65bd5e-3fdf-4002-b166-bde7fb8863fa"],"items":{"type":"string"}},"shipping_address":{"$ref":"#/components/schemas/Address","description":"The default shipping `Address` of the `User`.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"reports_to":{"type":"string","description":"The ID of the `User` it reports to.","example":"XMPL1234-000001"},"roles":{"type":"array","description":"The list of `UserRole` of the `User`.","items":{"$ref":"#/components/schemas/UserRole"}},"contact_id":{"type":"string","description":"The ID of the `Contact` assigned to the `User`. This information can be updated from the [Add Contact](ref:contact-add) and [Update Contact](ref:contact-update) endpoints.","example":"135fdb6c-2e77-4fc0-a79f-2453fde75ef7"},"creation_time":{"type":"string","description":"The date and time when the `User` was created (sortable: yes).","example":"2017-06-01T12:48:40Z"},"last_update":{"type":"string","description":"The date and time when the `User` was last updated (sortable: yes).","example":"2017-06-01T12:48:40Z"},"work_status":{"$ref":"#/components/schemas/WorkStatus","description":"The work status of the `User`.","example":"OUT_OF_OFFICE"}}},"UserRole":{"properties":{"id":{"type":"string","description":"The ID of the `UserRole`.","example":"superAdmin"},"name":{"type":"string","description":"The name of the `UserRole`.","example":"superAdmin"},"description":{"type":"string","description":"The description of the `UserRole`.","example":"The SuperAdmin role"},"scope":{"type":"string","description":"The scope of the `UserRole`.","example":"ALL"}}},"UserStatus":{"type":"string","enum":["ACTIVE","INACTIVE","BLOCKED","SUSPENDED","PENDING","ARCHIVED"]},"VatRate":{"properties":{"id":{"type":"string","description":"The `VATRate` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"code":{"type":"string","description":"The code of the `VATRate`.","example":"code-vat-11"},"name":{"type":"string","description":"The name of the `VATRate`","example":"Tax 11"},"description":{"type":"string","description":"A custom description of the `VATRate`.","example":"Number 11 of Tax code"},"percentage":{"type":"number","format":"double","description":"The percentage value of the `VATRate`","example":15},"enabled":{"type":"boolean","description":"The `VATRate` is visible in the transaction detail.","example":true},"integration":{"type":"string","description":"The `VATRate`'s corresponding integration.","example":"something"},"creation_time":{"type":"string","description":"The date and time when the `VATRate` was created (sortable: yes).","example":"2017-06-01T12:48:40Z"},"last_update_time":{"type":"string","description":"The date and time when the `VATRate` was last updated (sortable: yes).","example":"2017-06-01T12:48:40Z"}}},"WorkStatus":{"type":"string","enum":["AVAILABLE","OUT_OF_OFFICE"]},"BillingEvent":{"properties":{"event_uuid":{"type":"string","description":"The webhook unique ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"event_type":{"$ref":"#/components/schemas/WebhookEventType","default":"Transaction","description":"The webhook event type.","example":"Transaction"},"event_name":{"$ref":"#/components/schemas/WebhookEventName","default":"billing","description":"The webhook event name.","example":"billing"},"company_account_id":{"type":"string","description":"The company account ID.","example":"XMPL1234"},"data":{"$ref":"#/components/schemas/Transaction","description":"The webhook `Transaction` data."},"subscription_id":{"type":"string","description":"The webhook subscription ID used to route this event.","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"}}},"CardAuthorizationEvent":{"properties":{"event_uuid":{"type":"string","description":"The webhook unique ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"event_type":{"$ref":"#/components/schemas/WebhookEventType","default":"Transaction","description":"The webhook event type.","example":"Transaction"},"event_name":{"$ref":"#/components/schemas/WebhookEventName","default":"card_authorization","description":"The webhook event name.","example":"card_authorization"},"company_account_id":{"type":"string","description":"The company account ID.","example":"XMPL1234"},"data":{"$ref":"#/components/schemas/Transaction","description":"The webhook `Transaction` data."},"subscription_id":{"type":"string","description":"The webhook subscription ID used to route this event.","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"}}},"ConversionEvent":{"properties":{"event_uuid":{"type":"string","description":"The webhook unique ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"event_type":{"$ref":"#/components/schemas/WebhookEventType","default":"Transaction","description":"The webhook event type.","example":"Transaction"},"event_name":{"$ref":"#/components/schemas/WebhookEventName","default":"conversion","description":"The webhook event name.","example":"conversion"},"company_account_id":{"type":"string","description":"The company account ID.","example":"XMPL1234"},"data":{"$ref":"#/components/schemas/Transaction","description":"The webhook `Transaction` data."},"subscription_id":{"type":"string","description":"The webhook subscription ID used to route this event.","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"}}},"CustomerCareDepositEvent":{"properties":{"event_uuid":{"type":"string","description":"The webhook unique ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"event_type":{"$ref":"#/components/schemas/WebhookEventType","default":"Transaction","description":"The webhook event type.","example":"Transaction"},"event_name":{"$ref":"#/components/schemas/WebhookEventName","default":"customer_care_deposit","description":"The webhook event name.","example":"customer_care_deposit"},"company_account_id":{"type":"string","description":"The company account ID.","example":"XMPL1234"},"data":{"$ref":"#/components/schemas/Transaction","description":"The webhook `Transaction` data."},"subscription_id":{"type":"string","description":"The webhook subscription ID used to route this event.","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"}}},"CustomerCareWithdrawEvent":{"properties":{"event_uuid":{"type":"string","description":"The webhook unique ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"event_type":{"$ref":"#/components/schemas/WebhookEventType","default":"Transaction","description":"The webhook event type.","example":"Transaction"},"event_name":{"$ref":"#/components/schemas/WebhookEventName","default":"customer_care_withdraw","description":"The webhook event name.","example":"customer_care_withdraw"},"company_account_id":{"type":"string","description":"The company account ID.","example":"XMPL1234"},"data":{"$ref":"#/components/schemas/Transaction","description":"The webhook `Transaction` data."},"subscription_id":{"type":"string","description":"The webhook subscription ID used to route this event.","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"}}},"EditTagEvent":{"properties":{"event_uuid":{"type":"string","description":"The webhook unique ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"event_type":{"$ref":"#/components/schemas/WebhookEventType","default":"Transaction","description":"The webhook event type.","example":"Transaction"},"event_name":{"$ref":"#/components/schemas/WebhookEventName","default":"edit_tag","description":"The webhook event name.","example":"edit_tag"},"company_account_id":{"type":"string","description":"The company account ID.","example":"XMPL1234"},"data":{"$ref":"#/components/schemas/Transaction","description":"The webhook `Transaction` data."},"subscription_id":{"type":"string","description":"The webhook subscription ID used to route this event.","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"}}},"InboundPaymentEvent":{"properties":{"event_uuid":{"type":"string","description":"The webhook unique ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"event_type":{"$ref":"#/components/schemas/WebhookEventType","default":"Transaction","description":"The webhook event type.","example":"Transaction"},"event_name":{"$ref":"#/components/schemas/WebhookEventName","default":"inbound_payment","description":"The webhook event name.","example":"inbound_payment"},"company_account_id":{"type":"string","description":"The company account ID.","example":"XMPL1234"},"data":{"$ref":"#/components/schemas/Transaction","description":"The webhook `Transaction` data."},"subscription_id":{"type":"string","description":"The webhook subscription ID used to route this event.","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"}}},"InboundPaymentReversalEvent":{"properties":{"event_uuid":{"type":"string","description":"The webhook unique ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"event_type":{"$ref":"#/components/schemas/WebhookEventType","default":"Transaction","description":"The webhook event type.","example":"Transaction"},"event_name":{"$ref":"#/components/schemas/WebhookEventName","default":"inbound_payment_reversal","description":"The webhook event name.","example":"inbound_payment_reversal"},"company_account_id":{"type":"string","description":"The company account ID.","example":"XMPL1234"},"data":{"$ref":"#/components/schemas/Transaction","description":"The webhook `Transaction` data."},"subscription_id":{"type":"string","description":"The webhook subscription ID used to route this event.","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"}}},"InternalTransferEvent":{"properties":{"event_uuid":{"type":"string","description":"The webhook unique ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"event_type":{"$ref":"#/components/schemas/WebhookEventType","default":"Transaction","description":"The webhook event type.","example":"Transaction"},"event_name":{"$ref":"#/components/schemas/WebhookEventName","default":"internal_transfer","description":"The webhook event name.","example":"internal_transfer"},"company_account_id":{"type":"string","description":"The company account ID.","example":"XMPL1234"},"data":{"$ref":"#/components/schemas/Transaction","description":"The webhook `Transaction` data."},"subscription_id":{"type":"string","description":"The webhook subscription ID used to route this event.","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"}}},"JouleFeedEvent":{"properties":{"event_uuid":{"type":"string","description":"The webhook unique ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"event_type":{"$ref":"#/components/schemas/WebhookEventType","default":"Transaction","description":"The webhook event type.","example":"Transaction"},"event_name":{"$ref":"#/components/schemas/WebhookEventName","default":"joule_feed","description":"The webhook event name.","example":"joule_feed"},"company_account_id":{"type":"string","description":"The company account ID.","example":"XMPL1234"},"data":{"$ref":"#/components/schemas/Transaction","description":"The webhook `Transaction` data."},"subscription_id":{"type":"string","description":"The webhook subscription ID used to route this event.","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"}}},"TransactionModifiedEvent":{"properties":{"event_uuid":{"type":"string","description":"The webhook unique ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"event_type":{"$ref":"#/components/schemas/WebhookEventType","default":"Transaction","description":"The webhook event type.","example":"Transaction"},"event_name":{"$ref":"#/components/schemas/WebhookEventName","default":"transaction_modified","description":"The webhook event name.","example":"transaction_modified"},"company_account_id":{"type":"string","description":"The company account ID.","example":"XMPL1234"},"data":{"$ref":"#/components/schemas/Transaction","description":"The webhook `Transaction` data."},"subscription_id":{"type":"string","description":"The webhook subscription ID used to route this event.","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"}}},"LoadFailedEvent":{"properties":{"event_uuid":{"type":"string","description":"The webhook unique ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"event_type":{"$ref":"#/components/schemas/WebhookEventType","default":"Transaction","description":"The webhook event type.","example":"Transaction"},"event_name":{"$ref":"#/components/schemas/WebhookEventName","default":"load_failed","description":"The webhook event name.","example":"load_failed"},"company_account_id":{"type":"string","description":"The company account ID.","example":"XMPL1234"},"data":{"$ref":"#/components/schemas/Transaction","description":"The webhook `Transaction` data."},"subscription_id":{"type":"string","description":"The webhook subscription ID used to route this event.","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"}}},"LoadMoneyEvent":{"properties":{"event_uuid":{"type":"string","description":"The webhook unique ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"event_type":{"$ref":"#/components/schemas/WebhookEventType","default":"Transaction","description":"The webhook event type.","example":"Transaction"},"event_name":{"$ref":"#/components/schemas/WebhookEventName","default":"load_money","description":"The webhook event name.","example":"load_money"},"company_account_id":{"type":"string","description":"The company account ID.","example":"XMPL1234"},"data":{"$ref":"#/components/schemas/Transaction","description":"The webhook `Transaction` data."},"subscription_id":{"type":"string","description":"The webhook subscription ID used to route this event.","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"}}},"RecurringBillingEvent":{"properties":{"event_uuid":{"type":"string","description":"The webhook unique ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"event_type":{"$ref":"#/components/schemas/WebhookEventType","default":"Transaction","description":"The webhook event type.","example":"Transaction"},"event_name":{"$ref":"#/components/schemas/WebhookEventName","default":"recurring_billing","description":"The webhook event name.","example":"recurring_billing"},"company_account_id":{"type":"string","description":"The company account ID.","example":"XMPL1234"},"data":{"$ref":"#/components/schemas/Transaction","description":"The webhook `Transaction` data."},"subscription_id":{"type":"string","description":"The webhook subscription ID used to route this event.","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"}}},"ScheduledTransferEvent":{"properties":{"event_uuid":{"type":"string","description":"The webhook unique ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"event_type":{"$ref":"#/components/schemas/WebhookEventType","default":"Transaction","description":"The webhook event type.","example":"Transaction"},"event_name":{"$ref":"#/components/schemas/WebhookEventName","default":"scheduled_transfer","description":"The webhook event name.","example":"scheduled_transfer"},"company_account_id":{"type":"string","description":"The company account ID.","example":"XMPL1234"},"data":{"$ref":"#/components/schemas/Transaction","description":"The webhook `Transaction` data."},"subscription_id":{"type":"string","description":"The webhook subscription ID used to route this event.","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"}}},"TransactionAdjustmentEvent":{"properties":{"event_uuid":{"type":"string","description":"The webhook unique ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"event_type":{"$ref":"#/components/schemas/WebhookEventType","default":"Transaction","description":"The webhook event type.","example":"Transaction"},"event_name":{"$ref":"#/components/schemas/WebhookEventName","default":"transaction_adjustment","description":"The webhook event name.","example":"transaction_adjustment"},"company_account_id":{"type":"string","description":"The company account ID.","example":"XMPL1234"},"data":{"$ref":"#/components/schemas/Transaction","description":"The webhook `Transaction` data."},"subscription_id":{"type":"string","description":"The webhook subscription ID used to route this event.","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"}}},"UnloadMoneyEvent":{"properties":{"event_uuid":{"type":"string","description":"The webhook unique ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"event_type":{"$ref":"#/components/schemas/WebhookEventType","default":"Transaction","description":"The webhook event type.","example":"Transaction"},"event_name":{"$ref":"#/components/schemas/WebhookEventName","default":"unload_money","description":"The webhook event name.","example":"unload_money"},"company_account_id":{"type":"string","description":"The company account ID.","example":"XMPL1234"},"data":{"$ref":"#/components/schemas/Transaction","description":"The webhook `Transaction` data."},"subscription_id":{"type":"string","description":"The webhook subscription ID used to route this event.","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"}}},"WiretransferEvent":{"properties":{"event_uuid":{"type":"string","description":"The webhook unique ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"event_type":{"$ref":"#/components/schemas/WebhookEventType","default":"Transaction","description":"The webhook event type.","example":"Transaction"},"event_name":{"$ref":"#/components/schemas/WebhookEventName","default":"wiretransfer","description":"The webhook event name.","example":"wiretransfer"},"company_account_id":{"type":"string","description":"The company account ID.","example":"XMPL1234"},"data":{"$ref":"#/components/schemas/Transaction","description":"The webhook `Transaction` data."},"subscription_id":{"type":"string","description":"The webhook subscription ID used to route this event.","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"}}},"TransactionAttachment":{"properties":{"attachment_id":{"type":"string","description":"The `TransactionAttachment` ID.","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"},"transaction_id":{"type":"string","description":"The `Transaction` ID the file is attached to.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"file_name":{"type":"string","description":"The file name of the attachment.","example":"invoice01.jpg"},"file_extension":{"type":"string","description":"The file extension of the attachment.","example":".jpg"},"file_size":{"type":"integer","format":"int64","description":"The file size in bytes.","example":32768},"url":{"type":"string","description":"The url of the attachment."},"file_url":{"type":"string","deprecated":true,"description":"The Base64 string of the File URL encrypted by DES in ECB mode, Pkcs7 padding scheme and using Token for key. Deprecated, use `url` instead."},"url_type":{"$ref":"#/components/schemas/UrlType","description":"The URL type (DOWNLOAD_URL to download the attachment; UPLOAD_URL to upload the attachment).","example":"DOWNLOAD_URL"},"attachment_type":{"$ref":"#/components/schemas/TransactionAttachmentType","description":"The type of attachment.","example":"INVOICE"},"read_only":{"type":"boolean","description":"It determines whether the attachment can be removed or updated."},"content_type":{"type":"string","description":"The type of the `TransactionAttachment` content (default: 'binary/octet-stream').","example":"binary/octet-stream"},"upload_time":{"type":"string","description":"The date of upload.","example":"2017-06-01T12:48:40Z"},"attachment_user_id":{"type":"string","description":"The ID of the `User` that uploaded the attachment."},"upload_user_channel":{"$ref":"#/components/schemas/UploadUserChannel","description":"The channel used to upload the attachment )."},"compressed_file":{"$ref":"#/components/schemas/TransactionAttachmentCompressedFile","description":"The Compressed version of the attachment, Soldo automatically generates a compressedversion of any image type (e.g. `JPG`, `JPEG`, `PNG`) attachment having a size greater than `2.5MB`."},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"The metadata of the attachment."},"last_update_time":{"type":"string","description":"The date and time when the `TransactionAttachment` was last updated.","example":"2017-06-01T12:48:40Z"}}},"TransactionAttachmentCompressedFile":{"properties":{"file_name":{"type":"string","description":"The file name of the compressed attachment.","example":"invoice01_thumb.jpg"},"file_extension":{"type":"string","description":"The file extension of the compressed attachment.","example":".jpg"},"file_size":{"type":"integer","format":"int64","description":"The file size of the compressed attachment in bytes.","example":32768},"file_url":{"type":"string","deprecated":true,"description":"The Base64 string of the Compressed File URL encrypted by DES in ECB mode, Pkcs7 padding scheme and using Token for key. Deprecated, use `url` instead."},"url":{"type":"string","description":"The fileUrl  of the compressed attachment."},"url_type":{"$ref":"#/components/schemas/UrlType","description":"The URL type (DOWNLOAD_URL to download the attachment; UPLOAD_URL to upload the attachment).","example":"DOWNLOAD_URL"}}},"TransactionAttachmentType":{"type":"string","enum":["RECEIPT","INVOICE","MAIL","OTHER","PURCHASE_REQUEST","POP_AUTH","POP_SETTLEMENT"]},"UploadCompletedEvent":{"properties":{"event_uuid":{"type":"string","description":"The webhook unique ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"event_type":{"$ref":"#/components/schemas/WebhookEventType","default":"TransactionAttachment","description":"The webhook event type.","example":"TransactionAttachment"},"event_name":{"$ref":"#/components/schemas/WebhookEventName","default":"upload_completed","description":"The webhook event name.","example":"upload_completed"},"company_account_id":{"type":"string","description":"The company account ID.","example":"XMPL1234"},"data":{"$ref":"#/components/schemas/TransactionAttachment","description":"The webhook `TransactionAttachment` data."},"subscription_id":{"type":"string","description":"The webhook subscription ID used to route this event.","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"}}},"UploadUserChannel":{"type":"string","enum":["WEB","MOBILE","BO_USER","business","BAPI","PAPI","OTHER"]},"UrlType":{"type":"string","enum":["DOWNLOAD_URL","UPLOAD_URL","UPLOAD_COMPLETED","DELETE","THUMBNAILS_DOWNLOAD_URL","UPDATE_METADATA"]},"AttachmentDeleteEvent":{"properties":{"event_uuid":{"type":"string","description":"The webhook unique ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"event_type":{"$ref":"#/components/schemas/WebhookEventType","default":"TransactionAttachment","description":"The webhook event type.","example":"TransactionAttachment"},"event_name":{"$ref":"#/components/schemas/WebhookEventName","default":"attachment_delete","description":"The webhook event name.","example":"attachment_delete"},"company_account_id":{"type":"string","description":"The company account ID.","example":"XMPL1234"},"data":{"$ref":"#/components/schemas/TransactionAttachment","description":"The webhook `TransactionAttachment` data."},"subscription_id":{"type":"string","description":"The webhook subscription ID used to route this event.","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"}}},"NewUserEvent":{"properties":{"event_uuid":{"type":"string","description":"The webhook unique ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"event_type":{"$ref":"#/components/schemas/WebhookEventType","default":"Employee","description":"The webhook event type.","example":"Employee"},"event_name":{"$ref":"#/components/schemas/WebhookEventName","default":"new_user","description":"The webhook event name.","example":"new_user"},"company_account_id":{"type":"string","description":"The company account ID.","example":"XMPL1234"},"data":{"$ref":"#/components/schemas/User","description":"The webhook `User` data."},"subscription_id":{"type":"string","description":"The webhook subscription ID used to route this event.","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"}}},"UserStatusChangedEvent":{"properties":{"event_uuid":{"type":"string","description":"The webhook unique ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"event_type":{"$ref":"#/components/schemas/WebhookEventType","default":"Employee","description":"The webhook event type.","example":"Employee"},"event_name":{"$ref":"#/components/schemas/WebhookEventName","default":"user_status_changed","description":"The webhook event name.","example":"user_status_changed"},"company_account_id":{"type":"string","description":"The company account ID.","example":"XMPL1234"},"data":{"$ref":"#/components/schemas/User","description":"The webhook `User` data."},"subscription_id":{"type":"string","description":"The webhook subscription ID used to route this event.","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"}}},"UserUpdatedEvent":{"properties":{"event_uuid":{"type":"string","description":"The webhook unique ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"event_type":{"$ref":"#/components/schemas/WebhookEventType","default":"Employee","description":"The webhook event type.","example":"Employee"},"event_name":{"$ref":"#/components/schemas/WebhookEventName","default":"user_updated","description":"The webhook event name.","example":"user_updated"},"company_account_id":{"type":"string","description":"The company account ID.","example":"XMPL1234"},"data":{"$ref":"#/components/schemas/User","description":"The webhook `User` data."},"subscription_id":{"type":"string","description":"The webhook subscription ID used to route this event.","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"}}},"AccountInfoDeposit":{"type":"string","enum":["IBAN","SISAL","SORT_CODE","VIRTUAL_IBAN","SHARED_SWIFT","DEDICATED_SWIFT"]},"DepositAccountInfo":{"properties":{"type":{"$ref":"#/components/schemas/AccountInfoDeposit","description":"The `type` of account identification.","example":"IBAN"},"identification":{"type":"string","description":"The account identification related to the type.","example":"GB00ABCD00000123456789"}}},"PrimaryUserType":{"type":"string","description":"The type of resource assigned to the `Wallet`.","enum":["main","company","employee","dedicated"],"example":"company"},"Wallet":{"properties":{"id":{"type":"string","description":"The `Wallet` ID (sortable: yes)","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"name":{"type":"string","description":"The name of the `Wallet` (sortable: yes)","example":"CompanyWallet1"},"currency_code":{"$ref":"#/components/schemas/ISO4217Currency","description":"The [ISO 4217](https://www.six-group.com/en/products-services/financial-information/data-standards.html#scrollTo=maintenance-agency) code of the currency of the `Wallet` (sortable: no)","example":"EUR"},"available_amount":{"type":"number","description":"The currently available balance of the `Wallet` (sortable: no)","example":100},"blocked_amount":{"type":"number","description":"The blocked balance of the `Wallet` (the overall amount of `Transactions` in `Authorised` status) (sortable: no)","example":0},"primary_user_type":{"$ref":"#/components/schemas/PrimaryUserType","description":"The type of resource assigned to the `Wallet` (sortable: no)","example":"dedicated"},"primary_user_public_id":{"type":"string","description":"The ID of the `User` if the `Wallet` is of type `employee`, not available for other `Wallet` types (sortable: no)","example":"XMPL1234-000001"},"custom_reference_id":{"type":"string","description":"The custom reference of the `User` if the `Wallet` is of type `employee`, not available for other wallet types (sortable: yes)","example":"123456-usa-1"},"group_id":{"type":"string","deprecated":true,"description":"The ID of the `Group` the wallet is related to (sortable: no). In case of multiple groups associated this field contains the first one for backward compatibility.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"groups":{"type":"array","description":"The list of `Group` ID the wallet is related to (sortable: no)","example":["7bf79328-a7ae-4222-aa54-091ff7f429a7","2d65bd5e-3fdf-4002-b166-bde7fb8863fa"],"items":{"type":"string"}},"label":{"type":"string","description":"The label of the `Wallet` (sortable: yes)","example":"CompanyWallet1"},"visible":{"type":"boolean","description":"It determines whether the `Wallet` is visible on the web console (sortable: yes)","example":true},"creation_time":{"type":"string","description":"The date and time when the `Wallet` was created (sortable: yes)","example":"2017-06-01T12:48:40Z"},"last_update":{"type":"string","description":"The date and time when the `Wallet` was last updated (sortable: yes)","example":"2017-06-01T12:48:40Z"},"deposit_account_info":{"type":"array","description":"The deposit account info of the `Wallet`.","example":["7bf79328-a7ae-4222-aa54-091ff7f429a7","2d65bd5e-3fdf-4002-b166-bde7fb8863fa"],"items":{"$ref":"#/components/schemas/DepositAccountInfo"}},"description":{"type":"string","description":"The note of the `Wallet` (sortable: yes)","example":"CompanyWallet1"}}},"WalletCreatedEvent":{"properties":{"event_uuid":{"type":"string","description":"The webhook unique ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"event_type":{"$ref":"#/components/schemas/WebhookEventType","default":"Wallet","description":"The webhook event type.","example":"Wallet"},"event_name":{"$ref":"#/components/schemas/WebhookEventName","default":"wallet_created","description":"The webhook event name.","example":"wallet_created"},"company_account_id":{"type":"string","description":"The company account ID.","example":"XMPL1234"},"data":{"$ref":"#/components/schemas/Wallet","description":"The webhook `Wallet` data."},"subscription_id":{"type":"string","description":"The webhook subscription ID used to route this event.","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"}}},"WalletDeletedEvent":{"properties":{"event_uuid":{"type":"string","description":"The webhook unique ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"event_type":{"$ref":"#/components/schemas/WebhookEventType","default":"Wallet","description":"The webhook event type.","example":"Wallet"},"event_name":{"$ref":"#/components/schemas/WebhookEventName","default":"wallet_deleted","description":"The webhook event name.","example":"wallet_deleted"},"company_account_id":{"type":"string","description":"The company account ID.","example":"XMPL1234"},"data":{"$ref":"#/components/schemas/Wallet","description":"The webhook `Wallet` data."},"subscription_id":{"type":"string","description":"The webhook subscription ID used to route this event.","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"}}},"VatDeductibilityPercentage":{"type":"string","enum":["NONE","40","80","100"]},"Vehicle":{"properties":{"id":{"type":"string","description":"The `Vehicle` ID (sortable: no).","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"number_plate":{"type":"string","description":"The plate number of the `Vehicle` (sortable: yes).","example":"AA000BB"},"description":{"type":"string","description":"The description of the `Vehicle` (sortable: no).","example":"Employee electric vehicle"},"vat_deductible":{"$ref":"#/components/schemas/VatDeductibilityPercentage","description":"The VAT deductibility rate (sortable: no).","example":40},"fuel_type":{"$ref":"#/components/schemas/FuelType","description":"The fuel type (sortable: no).","example":"PETROL"},"status":{"$ref":"#/components/schemas/VehicleStatus","description":"The vehicle status (sortable: no).","example":"ACTIVE"},"creation_time":{"type":"string","description":"The date and time when the `Vehicle` was created (sortable: yes).","example":"2017-06-01T12:48:40Z"},"last_update_time":{"type":"string","description":"The last date and time when the `Vehicle` was updated (sortable: yes).","example":"2017-06-01T12:48:40Z"},"card_ids":{"type":"array","description":"The list of `Card` ID associated with the vehicle (sortable: no).","example":["7bf79328-a7ae-4222-aa54-091ff7f429a7","2d65bd5e-3fdf-4002-b166-bde7fb8863fa"],"items":{"type":"string"}},"reimbursement_rate":{"type":"number","description":"The rate to apply for a `MileageReimbursement`, measured in main `Wallet` currency per km (sortable: no).","example":0.45}}},"VehicleCreateEvent":{"properties":{"event_uuid":{"type":"string","description":"The webhook unique ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"event_type":{"$ref":"#/components/schemas/WebhookEventType","default":"Vehicle","description":"The webhook event type.","example":"Vehicle"},"event_name":{"$ref":"#/components/schemas/WebhookEventName","default":"vehicle_create","description":"The webhook event name.","example":"vehicle_create"},"company_account_id":{"type":"string","description":"The company account ID.","example":"XMPL1234"},"data":{"$ref":"#/components/schemas/Vehicle","description":"The webhook `Vehicle` data."},"subscription_id":{"type":"string","description":"The webhook subscription ID used to route this event.","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"}}},"VehicleStatus":{"type":"string","enum":["ACTIVE","ARCHIVED"]},"VehicleUpdateEvent":{"properties":{"event_uuid":{"type":"string","description":"The webhook unique ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"event_type":{"$ref":"#/components/schemas/WebhookEventType","default":"Vehicle","description":"The webhook event type.","example":"Vehicle"},"event_name":{"$ref":"#/components/schemas/WebhookEventName","default":"vehicle_update","description":"The webhook event name.","example":"vehicle_update"},"company_account_id":{"type":"string","description":"The company account ID.","example":"XMPL1234"},"data":{"$ref":"#/components/schemas/Vehicle","description":"The webhook `Vehicle` data."},"subscription_id":{"type":"string","description":"The webhook subscription ID used to route this event.","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"}}},"VehicleDeleteEvent":{"properties":{"event_uuid":{"type":"string","description":"The webhook unique ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"event_type":{"$ref":"#/components/schemas/WebhookEventType","default":"Vehicle","description":"The webhook event type.","example":"Vehicle"},"event_name":{"$ref":"#/components/schemas/WebhookEventName","default":"vehicle_delete","description":"The webhook event name.","example":"vehicle_delete"},"company_account_id":{"type":"string","description":"The company account ID.","example":"XMPL1234"},"data":{"$ref":"#/components/schemas/Vehicle","description":"The webhook `Vehicle` data."},"subscription_id":{"type":"string","description":"The webhook subscription ID used to route this event.","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"}}},"Purchase":{"properties":{"id":{"type":"string","description":"The `Purchase` ID (sortable: no).","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"status":{"$ref":"#/components/schemas/PurchaseStatus","description":"The status of the `Purchase` (sortable: no).","example":"ASSIGNED"},"title":{"type":"string","description":"The name of the `Purchase` (sortable: no).","example":"Tech book"},"description":{"type":"string","description":"The description of the `Purchase` (sortable: no).","example":"A purchase to approve"},"amount":{"type":"number","description":"The maximum spendable amount of the `Purchase` (sortable: no).","example":10.25},"amount_currency":{"$ref":"#/components/schemas/ISO4217Currency","description":"The currency of the `Purchase` ([ISO 4217](https://www.six-group.com/en/products-services/financial-information/data-standards.html#scrollTo=maintenance-agency) code) (sortable: no).","example":"EUR"},"wallet_id":{"type":"string","description":"The ID of the `Wallet` the money are taken from, the funding source of the `Purchase` (sortable: no).","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"},"wallet_name":{"type":"string","description":"The name of the `Wallet` the money are taken from, the funding source of the `Purchase` (sortable: no).","example":"John Doe"},"has_attachments":{"type":"boolean","description":"It determines whether the `Purchase` has one or more attachments (sortable: no).","example":true},"notes":{"type":"string","description":"The notes of the `Purchase` (sortable: no).","example":"Notes about the purchase request"},"assignee_id":{"type":"string","description":"The ID of the `User` assigned to the `Purchase` (sortable: no).","example":"XMPL1234-000003"},"assignee_custom_reference_id":{"type":"string","description":"The custom reference of the `User` assigned to the `Purchase` (sortable: no).","example":"123456-user-1"},"author_id":{"type":"string","description":"The ID of the `User` that created the `Purchase` (sortable: no).","example":"XMPL1234-000001"},"author_custom_reference_id":{"type":"string","description":"The custom reference of the `User` that created the purchase (sortable: no).","example":"123456-user-2"},"expiration_date":{"type":"string","description":"The date and time when the `Purchase` will expire (sortable: no).","example":"2017-06-01T12:48:40Z"},"card_id":{"type":"string","description":"The ID of the `Card` created by the `Purchase` (sortable: no).","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"},"transactions":{"type":"array","description":"The `Transactions` originated by the `Purchase` (sortable: no).","items":{"$ref":"#/components/schemas/PurchaseTransaction"}},"max_tx_number":{"type":"integer","format":"int32","description":"The max number of the `Transactions` that can be made with the `Card`.","example":3},"creation_time":{"type":"string","description":"The date and time when the `Purchase` was created (sortable: yes).","example":"2017-06-01T12:48:40Z"},"last_update_time":{"type":"string","description":"The date and time when the `Purchase` was last updated (sortable: yes).","example":"2017-06-01T12:48:40Z"}}},"PurchaseCreateEvent":{"properties":{"event_uuid":{"type":"string","description":"The webhook unique ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"event_type":{"$ref":"#/components/schemas/WebhookEventType","default":"Purchase","description":"The webhook event type.","example":"Purchase"},"event_name":{"$ref":"#/components/schemas/WebhookEventName","default":"purchase_create","description":"The webhook event name.","example":"purchase_create"},"company_account_id":{"type":"string","description":"The company account ID.","example":"XMPL1234"},"data":{"$ref":"#/components/schemas/Purchase","description":"The webhook `Purchase` data."},"subscription_id":{"type":"string","description":"The webhook subscription ID used to route this event.","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"}}},"PurchaseStatus":{"type":"string","enum":["SUCCESSFUL","ACTIVE","ASSIGNED","DELETED","EXPIRED","REQUEST_EXTENSION"]},"PurchaseTransaction":{"properties":{"id":{"type":"string","description":"The `Transaction` ID (sortable: no)","example":"c861cc24-6663-410f-8c78-73f886fff4ef"},"amount":{"type":"number","description":"The maximum spendable amount of the `Purchase` (sortable: no)","example":10.25},"amount_currency":{"$ref":"#/components/schemas/ISO4217Currency","description":"The currency of the `Purchase` ([ISO 4217](https://www.six-group.com/en/products-services/financial-information/data-standards.html#scrollTo=maintenance-agency) code) (sortable: no)","example":"EUR"},"completed_time":{"type":"string","description":"The date and time when the `Purchase` was completed (sortable: no)","example":"2017-06-01T12:48:40Z"},"transaction_category":{"type":"string","description":"The category of the `Transaction` (sortable: no)"}}},"PurchaseUpdateEvent":{"properties":{"event_uuid":{"type":"string","description":"The webhook unique ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"event_type":{"$ref":"#/components/schemas/WebhookEventType","default":"Purchase","description":"The webhook event type.","example":"Purchase"},"event_name":{"$ref":"#/components/schemas/WebhookEventName","default":"purchase_update","description":"The webhook event name.","example":"purchase_update"},"company_account_id":{"type":"string","description":"The company account ID.","example":"XMPL1234"},"data":{"$ref":"#/components/schemas/Purchase","description":"The webhook `Purchase` data."},"subscription_id":{"type":"string","description":"The webhook subscription ID used to route this event.","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"}}},"PurchaseDeleteEvent":{"properties":{"event_uuid":{"type":"string","description":"The webhook unique ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"event_type":{"$ref":"#/components/schemas/WebhookEventType","default":"Purchase","description":"The webhook event type.","example":"Purchase"},"event_name":{"$ref":"#/components/schemas/WebhookEventName","default":"purchase_delete","description":"The webhook event name.","example":"purchase_delete"},"company_account_id":{"type":"string","description":"The company account ID.","example":"XMPL1234"},"data":{"$ref":"#/components/schemas/Purchase","description":"The webhook `Purchase` data."},"subscription_id":{"type":"string","description":"The webhook subscription ID used to route this event.","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"}}},"PurchaseRedeemCardEvent":{"properties":{"event_uuid":{"type":"string","description":"The webhook unique ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"event_type":{"$ref":"#/components/schemas/WebhookEventType","default":"Purchase","description":"The webhook event type.","example":"Purchase"},"event_name":{"$ref":"#/components/schemas/WebhookEventName","default":"purchase_redeem_card","description":"The webhook event name.","example":"purchase_redeem_card"},"company_account_id":{"type":"string","description":"The company account ID.","example":"XMPL1234"},"data":{"$ref":"#/components/schemas/Purchase","description":"The webhook `Purchase` data."},"subscription_id":{"type":"string","description":"The webhook subscription ID used to route this event.","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"}}},"CreatedExpenseConfigurationEvent":{"properties":{"event_uuid":{"type":"string","description":"The webhook unique ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"event_type":{"$ref":"#/components/schemas/WebhookEventType","default":"ExpenseReviewConfiguration","description":"The webhook event type.","example":"ExpenseReviewConfiguration"},"event_name":{"$ref":"#/components/schemas/WebhookEventName","default":"created_expense_configuration","description":"The webhook event name.","example":"created_expense_configuration"},"company_account_id":{"type":"string","description":"The company account ID.","example":"XMPL1234"},"data":{"$ref":"#/components/schemas/ExpenseReviewConfiguration","description":"The webhook `ExpenseReview` data."},"subscription_id":{"type":"string","description":"The webhook subscription ID used to route this event.","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"}}},"ExpenseConfigurationActivityGroup":{"type":"string","enum":["USER","COMPANY","PURCHASE","SUBSCRIPTION","ONLINE_ADS","OUT_OF_PLATFORM_COMPANY","OUT_OF_PLATFORM_PERSONAL"]},"ExpenseDateType":{"type":"string","enum":["TRANSACTION","SETTLEMENT"]},"ExpenseReviewConfiguration":{"properties":{"start_date":{"type":"string","description":"The starting date from which the expenses can be reviewed.","example":"2017-06-01T12:48:40Z"},"transaction_categories":{"type":"array","description":"It determines the filter by category of the `Transaction`.","items":{"$ref":"#/components/schemas/ExpenseTransactionCategory"},"uniqueItems":true},"activity_groups":{"type":"array","description":"It determines the filter by types of `Cards` whose `Transactions` are considered as expenses to be reviewed.","items":{"$ref":"#/components/schemas/ExpenseConfigurationActivityGroup"},"uniqueItems":true},"policy_url":{"type":"string","description":"The url of the company spending policy","example":"https://www.policy.pdf"},"start_date_type":{"$ref":"#/components/schemas/ExpenseDateType","description":"It determines the type of date filter to be used.","example":"SETTLEMENT"},"enabled":{"type":"boolean","description":"Indicates `ExpenseReview` configuration is enabled."},"locked":{"type":"boolean","description":"Indicates `ExpenseReview` configuration is locked.","example":false},"update_timestamp":{"type":"string","description":"The date and time when the configuration was last updated.","example":"2017-06-01T12:48:40Z"}}},"ExpenseTransactionCategory":{"type":"string","enum":["Payment","Withdrawal","Refund","Chargeback","MileageReimbursement"]},"DisabledExpenseConfigurationEvent":{"properties":{"event_uuid":{"type":"string","description":"The webhook unique ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"event_type":{"$ref":"#/components/schemas/WebhookEventType","default":"ExpenseReviewConfiguration","description":"The webhook event type.","example":"ExpenseReviewConfiguration"},"event_name":{"$ref":"#/components/schemas/WebhookEventName","default":"disabled_expense_configuration","description":"The webhook event name.","example":"disabled_expense_configuration"},"company_account_id":{"type":"string","description":"The company account ID.","example":"XMPL1234"},"data":{"$ref":"#/components/schemas/ExpenseReviewConfiguration","description":"The webhook `ExpenseReview` data."},"subscription_id":{"type":"string","description":"The webhook subscription ID used to route this event.","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"}}},"EnabledExpenseConfigurationEvent":{"properties":{"event_uuid":{"type":"string","description":"The webhook unique ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"event_type":{"$ref":"#/components/schemas/WebhookEventType","default":"ExpenseReviewConfiguration","description":"The webhook event type.","example":"ExpenseReviewConfiguration"},"event_name":{"$ref":"#/components/schemas/WebhookEventName","default":"enabled_expense_configuration","description":"The webhook event name.","example":"enabled_expense_configuration"},"company_account_id":{"type":"string","description":"The company account ID.","example":"XMPL1234"},"data":{"$ref":"#/components/schemas/ExpenseReviewConfiguration","description":"The webhook `ExpenseReview` data."},"subscription_id":{"type":"string","description":"The webhook subscription ID used to route this event.","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"}}},"UpdatedExpenseConfigurationEvent":{"properties":{"event_uuid":{"type":"string","description":"The webhook unique ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"event_type":{"$ref":"#/components/schemas/WebhookEventType","default":"ExpenseReviewConfiguration","description":"The webhook event type.","example":"ExpenseReviewConfiguration"},"event_name":{"$ref":"#/components/schemas/WebhookEventName","default":"updated_expense_configuration","description":"The webhook event name.","example":"updated_expense_configuration"},"company_account_id":{"type":"string","description":"The company account ID.","example":"XMPL1234"},"data":{"$ref":"#/components/schemas/ExpenseReviewConfiguration","description":"The webhook `ExpenseReview` data."},"subscription_id":{"type":"string","description":"The webhook subscription ID used to route this event.","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"}}},"CompletedTransactionsImportEvent":{"properties":{"event_uuid":{"type":"string","description":"The webhook unique ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"event_type":{"$ref":"#/components/schemas/WebhookEventType","default":"ExpenseReviewConfiguration","description":"The webhook event type.","example":"ExpenseReviewConfiguration"},"event_name":{"$ref":"#/components/schemas/WebhookEventName","default":"completed_transactions_import","description":"The webhook event name.","example":"completed_transactions_import"},"company_account_id":{"type":"string","description":"The company account ID.","example":"XMPL1234"},"data":{"$ref":"#/components/schemas/ExpenseReviewConfiguration","description":"The webhook `ExpenseReview` data."},"subscription_id":{"type":"string","description":"The webhook subscription ID used to route this event.","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"}}},"ExpenseReview":{"properties":{"transaction_id":{"type":"string","description":"The ID of the `Transaction`."},"expense_status":{"type":"string","description":"The status of the expense."},"expense_status_category":{"type":"string","description":"The status category of the expense."},"expense_type":{"type":"string","description":"The type of the expense."},"expense_date":{"type":"string","description":"The date of the expense."},"expense_reviewer":{"type":"string","description":"The review of the expense."},"transaction_ids":{"type":"array","description":"The `Transaction` IDs of the `ExpenseReport`.","example":["7bf79328-a7ae-4222-aa54-091ff7f429a7","2d65bd5e-3fdf-4002-b166-bde7fb8863fa"],"items":{"type":"string"}},"expense_report_protocol_ids":{"type":"array","description":"The `ExpenseReport` protocol IDs of the `ExpenseReport`.","example":["7bf79328-a7ae-4222-aa54-091ff7f429a7","2d65bd5e-3fdf-4002-b166-bde7fb8863fa"],"items":{"type":"string"}},"expense_report_id":{"type":"string","description":"The ID of the `ExpenseReport`."}}},"UpdatedTransactionEvent":{"properties":{"event_uuid":{"type":"string","description":"The webhook unique ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"event_type":{"$ref":"#/components/schemas/WebhookEventType","default":"ExpenseReview","description":"The webhook event type.","example":"ExpenseReview"},"event_name":{"$ref":"#/components/schemas/WebhookEventName","default":"updated_transaction","description":"The webhook event name.","example":"updated_transaction"},"company_account_id":{"type":"string","description":"The company account ID.","example":"XMPL1234"},"data":{"$ref":"#/components/schemas/ExpenseReview","description":"The webhook `ExpenseReview` data."},"subscription_id":{"type":"string","description":"The webhook subscription ID used to route this event.","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"}}},"ChangeExpenseTypeEvent":{"properties":{"event_uuid":{"type":"string","description":"The webhook unique ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"event_type":{"$ref":"#/components/schemas/WebhookEventType","default":"ExpenseReview","description":"The webhook event type.","example":"ExpenseReview"},"event_name":{"$ref":"#/components/schemas/WebhookEventName","default":"change_expense_type","description":"The webhook event name.","example":"change_expense_type"},"company_account_id":{"type":"string","description":"The company account ID.","example":"XMPL1234"},"data":{"$ref":"#/components/schemas/ExpenseReview","description":"The webhook `ExpenseReview` data."},"subscription_id":{"type":"string","description":"The webhook subscription ID used to route this event.","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"}}},"Subscription":{"properties":{"id":{"type":"string","description":"The `Subscription` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"name":{"type":"string","description":"The name of the `Subscription`.","example":"EXAMPLE SUBSCRIPTION."},"description":{"type":"string","description":"A custom description of the `Subscription`.","example":"This is a subscription"},"platform":{"$ref":"#/components/schemas/SubscriptionPlatform","description":"The platform the `Subscription` is made on.","example":"OTHER"},"assignees":{"type":"array","description":"List of `User` ID currently assigned to the `Subscription` and its `Card`.","example":["XMPL1234-000001","XMPL1234-000002","XMPL1234-000003"],"items":{"type":"string"}},"status":{"$ref":"#/components/schemas/SubscriptionStatus","description":"The status of the `Subscription`.","example":"ACTIVE"},"wallet_id":{"type":"string","description":"The ID of the `Wallet` the `Subscription` and its `Card` are linked to.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"payment_frequency":{"$ref":"#/components/schemas/SubscriptionPaymentFrequency","description":"The payment frequency indicates how often a `Transaction` is expected to be made.","example":"YEARLY"},"last_spent":{"type":"number","description":"The amount of the last `Transaction` made with the `Card`.","example":75.01},"total_spent":{"type":"number","description":"The overall amount spent with the `Card`.","example":775.01},"card_id":{"type":"string","description":"The ID of the `Card` reserved for this `Subscription` (only available after the subscription is activated).","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"},"last_spent_date":{"type":"string","description":"The date and time of the last `Transaction` made with the `Card`.","example":"2020-05-07T12:48:40Z"},"creation_time":{"type":"string","description":"The date and time when the `Subscription` was last updated.","example":"2017-06-01T12:48:40Z"},"last_update_time":{"type":"string","description":"The date and time when the `Subscription` was last updated.","example":"2017-06-01T12:48:40Z"}}},"SubscriptionActivatedEvent":{"properties":{"event_uuid":{"type":"string","description":"The webhook unique ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"event_type":{"$ref":"#/components/schemas/WebhookEventType","default":"Subscription","description":"The webhook event type.","example":"Subscription"},"event_name":{"$ref":"#/components/schemas/WebhookEventName","default":"subscription_activated","description":"The webhook event name.","example":"subscription_activated"},"company_account_id":{"type":"string","description":"The company account ID.","example":"XMPL1234"},"data":{"$ref":"#/components/schemas/Subscription","description":"The webhook `Subscription` data."},"subscription_id":{"type":"string","description":"The webhook subscription ID used to route this event.","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"}}},"SubscriptionPaymentFrequency":{"type":"string","enum":["OTHER","YEARLY","WEEKLY","QUARTERLY","MONTHLY"]},"SubscriptionPlatform":{"type":"string","enum":["ADOBE","AMAZON","APPLE","ATLASSIAN","FACEBOOK","FIGMA","GITHUB","GOOGLE","HUBSPOT","LINKEDIN","MICROSOFT","NOTION","OTHER","PINTEREST","SALESFORCE","TWITTER","XERO","ZOOM"]},"SubscriptionStatus":{"type":"string","enum":["ACTIVE","ASSIGNED","CANCELLED"]},"SubscriptionCreatedEvent":{"properties":{"event_uuid":{"type":"string","description":"The webhook unique ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"event_type":{"$ref":"#/components/schemas/WebhookEventType","default":"Subscription","description":"The webhook event type.","example":"Subscription"},"event_name":{"$ref":"#/components/schemas/WebhookEventName","default":"subscription_created","description":"The webhook event name.","example":"subscription_created"},"company_account_id":{"type":"string","description":"The company account ID.","example":"XMPL1234"},"data":{"$ref":"#/components/schemas/Subscription","description":"The webhook `Subscription` data."},"subscription_id":{"type":"string","description":"The webhook subscription ID used to route this event.","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"}}},"SubscriptionUpdatedEvent":{"properties":{"event_uuid":{"type":"string","description":"The webhook unique ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"event_type":{"$ref":"#/components/schemas/WebhookEventType","default":"Subscription","description":"The webhook event type.","example":"Subscription"},"event_name":{"$ref":"#/components/schemas/WebhookEventName","default":"subscription_updated","description":"The webhook event name.","example":"subscription_updated"},"company_account_id":{"type":"string","description":"The company account ID.","example":"XMPL1234"},"data":{"$ref":"#/components/schemas/Subscription","description":"The webhook `Subscription` data."},"subscription_id":{"type":"string","description":"The webhook subscription ID used to route this event.","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"}}},"SubscriptionDeletedEvent":{"properties":{"event_uuid":{"type":"string","description":"The webhook unique ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"event_type":{"$ref":"#/components/schemas/WebhookEventType","default":"Subscription","description":"The webhook event type.","example":"Subscription"},"event_name":{"$ref":"#/components/schemas/WebhookEventName","default":"subscription_deleted","description":"The webhook event name.","example":"subscription_deleted"},"company_account_id":{"type":"string","description":"The company account ID.","example":"XMPL1234"},"data":{"$ref":"#/components/schemas/Subscription","description":"The webhook `Subscription` data."},"subscription_id":{"type":"string","description":"The webhook subscription ID used to route this event.","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"}}},"SubscriptionAssigneeAddedEvent":{"properties":{"event_uuid":{"type":"string","description":"The webhook unique ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"event_type":{"$ref":"#/components/schemas/WebhookEventType","default":"Subscription","description":"The webhook event type.","example":"Subscription"},"event_name":{"$ref":"#/components/schemas/WebhookEventName","default":"subscription_assignee_added","description":"The webhook event name.","example":"subscription_assignee_added"},"company_account_id":{"type":"string","description":"The company account ID.","example":"XMPL1234"},"data":{"$ref":"#/components/schemas/Subscription","description":"The webhook `Subscription` data."},"subscription_id":{"type":"string","description":"The webhook subscription ID used to route this event.","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"}}},"SubscriptionAssigneeRemovedEvent":{"properties":{"event_uuid":{"type":"string","description":"The webhook unique ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"event_type":{"$ref":"#/components/schemas/WebhookEventType","default":"Subscription","description":"The webhook event type.","example":"Subscription"},"event_name":{"$ref":"#/components/schemas/WebhookEventName","default":"subscription_assignee_removed","description":"The webhook event name.","example":"subscription_assignee_removed"},"company_account_id":{"type":"string","description":"The company account ID.","example":"XMPL1234"},"data":{"$ref":"#/components/schemas/Subscription","description":"The webhook `Subscription` data."},"subscription_id":{"type":"string","description":"The webhook subscription ID used to route this event.","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"}}},"OnlineAds":{"properties":{"id":{"type":"string","description":"The `OnlineAds` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"name":{"type":"string","description":"The name of the `OnlineAds`.","example":"EXAMPLE ONLINE AD"},"description":{"type":"string","description":"A custom description of the `OnlineAds`.","example":"This is an online advertisement"},"platform":{"$ref":"#/components/schemas/OnlineAdsPlatform","description":"The platform the `OnlineAds` are made on.","example":"OTHER"},"assignees":{"type":"array","description":"List of `User` IDs currently assigned to the `OnlineAds` and its `Cards`.","example":["XMPL1234-000001","XMPL1234-000002","XMPL1234-000003"],"items":{"type":"string"}},"status":{"$ref":"#/components/schemas/OnlineAdsStatus","description":"The status of the `OnlineAds`.","example":"ACTIVE"},"wallet_id":{"type":"string","description":"The `Wallet` ID the `OnlineAds` and its `Card` are linked to.","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"},"last_spent_date":{"type":"string","description":"The date and time of the last `Transaction` made with the `Card`.","example":"2020-05-07T12:48:40Z"},"last_spent":{"type":"number","description":"The amount of the last `Transaction` made with the `Card`.","example":75.01},"total_spent":{"type":"number","description":"The overall amount spent with the `Card`.","example":775.01},"card_id":{"type":"string","description":"The ID of the `Card` reserved for this `OnlineAds` (only available after the `OnlineAds` has been activated).","example":"c861cc24-6663-410f-8c78-73f886fff4ef"},"creation_time":{"type":"string","description":"The date and time when the `OnlineAds` was created.","example":"2017-06-01T12:48:40Z"},"last_update_time":{"type":"string","description":"The date and time when the `OnlineAds` was last updated.","example":"2017-06-01T12:48:40Z"}}},"OnlineAdsActivatedEvent":{"properties":{"event_uuid":{"type":"string","description":"The webhook unique ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"event_type":{"$ref":"#/components/schemas/WebhookEventType","default":"OnlineAds","description":"The webhook event type.","example":"OnlineAds"},"event_name":{"$ref":"#/components/schemas/WebhookEventName","default":"online_ads_activated","description":"The webhook event name.","example":"online_ads_activated"},"company_account_id":{"type":"string","description":"The company account ID.","example":"XMPL1234"},"data":{"$ref":"#/components/schemas/OnlineAds","description":"The webhook `OnlineAds` data."},"subscription_id":{"type":"string","description":"The webhook subscription ID used to route this event.","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"}}},"OnlineAdsPlatform":{"type":"string","enum":["GOOGLE","TWITTER","TABOOLA","PINTEREST","MICROSOFT","FACEBOOK","AMAZON","APPLE","TIKTOK","LINKEDIN","INSTAGRAM","OTHER"]},"OnlineAdsStatus":{"type":"string","enum":["ACTIVE","ASSIGNED","CANCELLED"]},"OnlineAdsCreatedEvent":{"properties":{"event_uuid":{"type":"string","description":"The webhook unique ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"event_type":{"$ref":"#/components/schemas/WebhookEventType","default":"OnlineAds","description":"The webhook event type.","example":"OnlineAds"},"event_name":{"$ref":"#/components/schemas/WebhookEventName","default":"online_ads_created","description":"The webhook event name.","example":"online_ads_created"},"company_account_id":{"type":"string","description":"The company account ID.","example":"XMPL1234"},"data":{"$ref":"#/components/schemas/OnlineAds","description":"The webhook `OnlineAds` data."},"subscription_id":{"type":"string","description":"The webhook subscription ID used to route this event.","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"}}},"OnlineAdsUpdatedEvent":{"properties":{"event_uuid":{"type":"string","description":"The webhook unique ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"event_type":{"$ref":"#/components/schemas/WebhookEventType","default":"OnlineAds","description":"The webhook event type.","example":"OnlineAds"},"event_name":{"$ref":"#/components/schemas/WebhookEventName","default":"online_ads_updated","description":"The webhook event name.","example":"online_ads_updated"},"company_account_id":{"type":"string","description":"The company account ID.","example":"XMPL1234"},"data":{"$ref":"#/components/schemas/OnlineAds","description":"The webhook `OnlineAds` data."},"subscription_id":{"type":"string","description":"The webhook subscription ID used to route this event.","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"}}},"OnlineAdsDeletedEvent":{"properties":{"event_uuid":{"type":"string","description":"The webhook unique ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"event_type":{"$ref":"#/components/schemas/WebhookEventType","default":"OnlineAds","description":"The webhook event type.","example":"OnlineAds"},"event_name":{"$ref":"#/components/schemas/WebhookEventName","default":"online_ads_deleted","description":"The webhook event name.","example":"online_ads_deleted"},"company_account_id":{"type":"string","description":"The company account ID.","example":"XMPL1234"},"data":{"$ref":"#/components/schemas/OnlineAds","description":"The webhook `OnlineAds` data."},"subscription_id":{"type":"string","description":"The webhook subscription ID used to route this event.","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"}}},"OnlineAdsAssigneeAddedEvent":{"properties":{"event_uuid":{"type":"string","description":"The webhook unique ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"event_type":{"$ref":"#/components/schemas/WebhookEventType","default":"OnlineAds","description":"The webhook event type.","example":"OnlineAds"},"event_name":{"$ref":"#/components/schemas/WebhookEventName","default":"online_ads_assignee_added","description":"The webhook event name.","example":"online_ads_assignee_added"},"company_account_id":{"type":"string","description":"The company account ID.","example":"XMPL1234"},"data":{"$ref":"#/components/schemas/OnlineAds","description":"The webhook `OnlineAds` data."},"subscription_id":{"type":"string","description":"The webhook subscription ID used to route this event.","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"}}},"OnlineAdsAssigneeRemovedEvent":{"properties":{"event_uuid":{"type":"string","description":"The webhook unique ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"event_type":{"$ref":"#/components/schemas/WebhookEventType","default":"OnlineAds","description":"The webhook event type.","example":"OnlineAds"},"event_name":{"$ref":"#/components/schemas/WebhookEventName","default":"online_ads_assignee_removed","description":"The webhook event name.","example":"online_ads_assignee_removed"},"company_account_id":{"type":"string","description":"The company account ID.","example":"XMPL1234"},"data":{"$ref":"#/components/schemas/OnlineAds","description":"The webhook `OnlineAds` data."},"subscription_id":{"type":"string","description":"The webhook subscription ID used to route this event.","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"}}},"CreateAddress":{"description":"Create `Address` JSON parameters.","properties":{"recipient":{"type":"string","description":"The recipient of the addressee.","example":"JohnSmith"},"name":{"type":"string","description":"The actual name of the `Address`.","example":"Actual address of John"},"line1":{"type":"string","description":"The primary street of the `Address`.","example":"Foo street 33"},"line2":{"type":"string","description":"The optional secondary street.","example":"Second floor"},"country":{"$ref":"#/components/schemas/ISO3166Country","description":"The country code in [ISO 3166-1 alpha-3](https://www.iso.org/obp/ui/#search/code/) standard."},"county":{"type":"string","description":"The county code.","example":"00000"},"city":{"type":"string","description":"The city name.","example":"London"},"post_code":{"type":"string","description":"The post code of the city.","example":"00000"},"delivery_phone_number":{"type":"string","description":"The delivery phone including the country code.","example":"+44123323232"},"default_shipping":{"type":"boolean","description":"It is `true` if it's the default shipping address.","example":true},"user_id":{"type":"string","description":"The ID of the `User` owner of the `Address`, required only when `resource_type` is `USER`.","example":"XMPL1234-000003"},"cards_to_link":{"type":"array","items":{"description":"The list of the `Card` ID to link to the address","example":["7bf79328-a7ae-4222-aa54-091ff7f429a7","2d65bd5e-3fdf-4002-b166-bde7fb8863fa"]}}},"required":["city","country","line1","name","post_code"]},"Autotag":{"properties":{"id":{"type":"string","description":"The `Autotag` ID (sortable: no).","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"name":{"type":"string","description":"The name of the `Autotag` (sortable: no).","example":"AutotagRule"},"operation":{"$ref":"#/components/schemas/AutotagOperation","description":"The logical operator applied to the `Criteria` (AND, OR) (sortable: no).","example":"AND"},"criteria":{"type":"array","description":"The list of `Criteria` that need to be satisfied in order for the `Autotag` to be executed (sortable: no)","items":{"$ref":"#/components/schemas/AutotagCriteria"}},"expense_category_id":{"type":"string","description":"The ID of the `ExpenseCategory` of to be assigned to a `Transaction` satisfying the `Criteria` (sortable: no).","example":"c861cc24-6663-410f-8c78-73f886fff4ef"},"tax_rate_id":{"type":"string","description":"The ID of the `VATRate` to be assigned to a `Transaction` satisfying the `Criteria` (sortable: no).","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"},"tag_ids":{"type":"array","description":"The IDs of the `Tag` and related `List` to be assigned to a `Transaction` satisfying the `Criteria` (sortable: no)","items":{"$ref":"#/components/schemas/AutotagTag"}},"enabled":{"type":"boolean","description":"It determines whether the `Autotag` rule is enabled (if a rule is not enabled, it won't be executed) (sortable: no).","example":true},"owner_id":{"type":"string","description":"The `User` ID who created the `Autotag` (sortable: no).","example":"XMPL1234-000001"},"status":{"$ref":"#/components/schemas/AutotagStatus","description":"The status of the `Autotag` (sortable: no).","example":"VALID"},"creation_time":{"type":"string","description":"The date and time when the `Autotag` was created (sortable: no).","example":"2017-06-01T12:48:40Z"},"last_update_time":{"type":"string","description":"The date and time when the `Autotag` was last updated (sortable: no).","example":"2017-06-01T12:48:40Z"}}},"AutotagCriteria":{"properties":{"name":{"$ref":"#/components/schemas/AutotagCriteriaName","description":"The name of the criteria to be satisfied in order for the `Autotag` to be executed.","example":"MERCHANT_CATEGORY"},"value":{"type":"array","description":"The values of the criteria to be satisfied in order for the `Autotag` to be executed, in case of `USER`, `CARD`, `COMPANY_CARD` it's a list of IDs; in case of `MERCHANT_CATEGORY` it's one or more `MerchantCategories`; in case of `MERCHANT` it's a text string which should be included in the merchant name","example":["Entertainment"],"items":{"type":"string"}}}},"AutotagCriteriaName":{"type":"string","enum":["USER","CARD","COMPANY_CARD","MERCHANT_CATEGORY","MERCHANT"]},"AutotagOperation":{"type":"string","enum":["AND","OR"]},"AutotagStatus":{"type":"string","enum":["VALID","NOT_VALID","PARTIAL_VALID"]},"AutotagTag":{"properties":{"tag_id":{"type":"string","description":"The `Tag` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"dictionary_id":{"type":"string","description":"The `List` ID.","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"}}},"CreateAutotag":{"description":"Add `Autotag` JSON parameters.","properties":{"name":{"type":"string","description":"The name of the `Autotag`.","example":"Autotag"},"operation":{"$ref":"#/components/schemas/AutotagOperation","description":"The logical operator applied to the `Criteria`.","example":"AND"},"criteria":{"type":"array","description":"The list of `Criteria` that need to be satisfied in order for the `Autotag` to be executed.","items":{"$ref":"#/components/schemas/AutotagCriteria"}},"expense_category_id":{"type":"string","description":"The ID of the `ExpenseCategory` of to be assigned to a `Transaction` satisfying the `Criteria`.","example":"c861cc24-6663-410f-8c78-73f886fff4ef"},"tax_rate_id":{"type":"string","description":"The ID of the `VATRate` to be assigned to a `Transaction` satisfying the `Criteria`.","example":"c861cc24-6663-410f-8c78-73f886fff4ef"},"tag_ids":{"type":"array","description":"The IDs of the `Tag` and related `List` to be assigned to a `Transaction` satisfying the `Criteria`.","items":{"$ref":"#/components/schemas/AutotagTag"}}},"required":["criteria","name","operation"]},"BusinessTrip":{"properties":{"id":{"type":"string","description":"The `BusinessTrip` ID (sortable: no).","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"name":{"type":"string","description":"The name of the `BusinessTrip` (sortable: no).","example":"There and back again"},"description":{"type":"string","description":"The description of the `BusinessTrip` (sortable: no).","example":"EXAMPLE BUSINESS TRIP DESCRIPTION"},"destination":{"type":"string","description":"The destination of the `BusinessTrip` (sortable: no)."},"date_from":{"type":"string","description":"The start date of the `BusinessTrip` (sortable: no)."},"date_to":{"type":"string","description":"The end date of the `BusinessTrip` (sortable: no)."},"author_user_id":{"type":"string","description":"The ID of the `User` that created the `BusinessTrip` (sortable: no).","example":"XMPL1234-000001"},"approver_user_id":{"type":"string","description":"The ID of the `User` who approved the `BusinessTrip` (sortable: no).","example":"XMPL1234-000003"},"traveller_user_id":{"type":"string","description":"The ID of the traveller `User` assigned to the `BusinessTrip` (sortable: no).","example":"XMPL1234-000003"},"traveller_card_id":{"type":"string","description":"The ID of the `Card` where to transfer funds before and during the `BusinessTrip` (sortable: no).","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"},"money_transfer_mode":{"$ref":"#/components/schemas/BusinessTripMoneyTransferMode","description":"The mode of the money transfer before and during the `BusinessTrip` (sortable: no).","example":"SPLIT"},"status":{"$ref":"#/components/schemas/BusinessTripStatus","description":"The status of the `BusinessTrip` (sortable: no).","example":"ONGOING"},"purchase_state":{"$ref":"#/components/schemas/BusinessTripPurchaseStatus","description":"The purchase status of the `BusinessTrip` (sortable: no).","example":"ACTIVE"},"total_amount":{"type":"number","description":"The total amount of the `BusinessTrip` (sortable: no).","example":10.25},"total_amount_currency":{"$ref":"#/components/schemas/ISO4217Currency","description":"The currency of the total amount of the `BusinessTrip` (sortable: no).","example":"EUR"},"received_amount":{"type":"number","description":"The total amount already sent to the `Card` related to this `BusinessTrip` (sortable: no)."},"received_amount_currency":{"$ref":"#/components/schemas/ISO4217Currency","description":"The currency of the total amount already sent to the `Card` related to this `BusinessTrip` (sortable: no).","example":"EUR"},"scheduled_amount":{"type":"number","description":"The total amount still to send to the `Card` related to this `BusinessTrip` (sortable: no)."},"scheduled_amount_currency":{"$ref":"#/components/schemas/ISO4217Currency","description":"The currency of the total amount still to send to the `Card` related to this `BusinessTrip` (sortable: no).","example":"EUR"},"pre_action":{"$ref":"#/components/schemas/PreAction","description":"The action to be performed pre `BusinessTrip`(sortable: no)."},"post_action":{"$ref":"#/components/schemas/PostAction","description":"The action to be performed post the `BusinessTrip` (sortable: no)."},"wallet_id":{"type":"string","description":"The ID of the `Wallet` the money are taken from, the funding source of the `BusinessTrip` (sortable: no).","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"},"creation_time":{"type":"string","description":"The date and time when the `BusinessTrip` was created (sortable: yes).","example":"2017-06-01T12:48:40Z"},"last_update_time":{"type":"string","description":"The date and time when the `BusinessTrip` was last updated (sortable: yes).","example":"2017-06-01T12:48:40Z"},"expense_allocation":{"type":"array","description":"The list of `ExpenseAllocation` for the `BusinessTrip` (sortable: no).","items":{"$ref":"#/components/schemas/BusinessTripExpense"}},"tags":{"type":"array","description":"The IDs of the `Tag` and related `Dictionary` to be assigned to a `BusinessTrip`.","items":{"$ref":"#/components/schemas/BusinessTripTag"}}}},"BusinessTripCardHandling":{"type":"string","enum":["KEEP_ACTIVE","BLOCK"]},"BusinessTripExpense":{"description":"Expense allocation: expense_category_id and description are mutually exclusive: provide expense_category_id (for an existing expense category) or description (for a custom expense), but not both.","properties":{"expense_category_id":{"type":"string","description":"The ID of the `ExpenseCategory` related to this `BusinessTripExpense`. Required if description is not provided. Mutually exclusive with `expense_category_id`: provide either `description` (for a custom expense) or `expense_category_id` (for an existing expense category), but not both.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"spend_period":{"$ref":"#/components/schemas/BusinessTripExpenseSpendPeriod","description":"The spend period of the `BusinessTripExpense`.","example":"BEFORE_TRIP"},"amount":{"type":"number","description":"The amount of the `BusinessTripExpense`.","example":10.25},"amount_currency":{"$ref":"#/components/schemas/ISO4217Currency","description":"The currency of the amount of the `BusinessTripExpense`.","example":"EUR"},"description":{"type":"string","description":"The custom name of the `BusinessTripExpense`. Required if expenseCategoryId is not provided. Mutually exclusive with `expense_category_id`: provide either `description` (for a custom expense) or `expense_category_id` (for an existing expense category), but not both.","example":"CUSTOM_EXPENSE"}},"required":["amount","amount_currency","spend_period"]},"BusinessTripExpenseSpendPeriod":{"type":"string","enum":["BEFORE_TRIP","DURING_TRIP"]},"BusinessTripMoneyTransferMode":{"type":"string","enum":["SPLIT","FULL"]},"BusinessTripPreAction":{"type":"string","enum":["CARD_ACTIVATE","CARD_KEEP_BLOCKED","FUNDS_TRANSFER_ON_WALLET","UNLOCK_COUNTRIES_ON_CARD"]},"BusinessTripPurchaseStatus":{"type":"string","description":"The status of the `Purchase`.","enum":["SUCCESSFUL","ACTIVE","ASSIGNED","DELETED","EXPIRED","REQUEST_EXTENSION"]},"BusinessTripStatus":{"type":"string","enum":["SCHEDULED","COMPLETED","ONGOING","DELETED","FINISHED"]},"BusinessTripTag":{"properties":{"tag_id":{"type":"string","description":"The `Tags` of the `BusinessTrip`.","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"},"dictionary_id":{"type":"string","description":"The `List` ID of the `Tag` of the `BusinessTrip`.","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"}}},"BusinessTripUnusedFunds":{"type":"string","enum":["LEAVE","REMOVE"]},"PostAction":{"properties":{"unused_funds":{"$ref":"#/components/schemas/BusinessTripUnusedFunds","description":"The action to be performed about the `BusinessTrip` unused funds (sortable: no)."},"card_handling":{"$ref":"#/components/schemas/BusinessTripCardHandling","description":"The status of the `Card` at the end of the `BusinessTrip` (sortable: no)."}}},"PreAction":{"properties":{"requested_action":{"type":"array","description":"The action to be performed about the `BusinessTrip` requestedAction (sortable: no).","items":{"$ref":"#/components/schemas/BusinessTripPreAction"},"uniqueItems":true}}},"CreateBusinessTrip":{"description":"Create `BusinessTrip` JSON parameters.","properties":{"request_timestamp":{"type":"integer","format":"int64","description":"The epoch timestamp in millis. This is checked in Soldo. Requests with timestamp older than 5 seconds will be rejected.","example":1576850500000},"name":{"type":"string","description":"The `BusinessTrip` name.","example":"EXAMPLE BUSINESS TRIP"},"description":{"type":"string","description":"The `BusinessTrip` description.","example":"EXAMPLE BUSINESS TRIP DESCRIPTION"},"destination":{"type":"string","description":"The `BusinessTrip` destination.","example":"monte fato"},"traveller_user_id":{"type":"string","description":"The `BusinessTrip` traveller User ID.","example":"XMPL1234-000001"},"traveller_card_id":{"type":"string","description":"The `BusinessTrip` `Card` ID where to transfer money.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"wallet_id":{"type":"string","description":"The ID of the `Wallet` the money are taken from, the funding source of the `BusinessTrip`.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"tags":{"type":"array","description":"The IDs of the `Tag` and related `Dictionary` to be assigned to the `BusinessTrip`.","items":{"$ref":"#/components/schemas/BusinessTripTag"}},"from_date":{"type":"string","description":"The `BusinessTrip` start date and time.","example":"2017-06-01T12:48:40Z"},"to_date":{"type":"string","description":"The `BusinessTrip` end date and time.","example":"2017-06-01T12:48:40Z"},"money_transfer_mode":{"$ref":"#/components/schemas/BusinessTripMoneyTransferMode","description":"The `BusinessTrip` money transfer mode.","example":"SPLIT"},"pre_action":{"$ref":"#/components/schemas/PreAction","description":"The action to be performed pre `BusinessTrip`(sortable: no)."},"post_action":{"$ref":"#/components/schemas/PostAction","description":"The action to be performed post `BusinessTrip` (sortable: no)."},"expense_allocation":{"type":"array","description":"The `BusinessTrip` expense allocation.","items":{"$ref":"#/components/schemas/BusinessTripExpense"}}},"required":["description","destination","from_date","money_transfer_mode","name","post_action","request_timestamp","to_date","traveller_card_id","traveller_user_id","wallet_id"]},"AddCardOrder":{"description":"Add `Card` JSON parameters.","properties":{"request_timestamp":{"type":"integer","format":"int64","description":"The epoch timestamp in millis. This is checked in Soldo. Requests with timestamp older than 5 seconds will be rejected.","example":1576850500000},"owner_type":{"$ref":"#/components/schemas/AddOrderCardOwnerType","description":"The type of the resource the `Card` is created for.","example":"employee"},"owner_public_id":{"type":"string","description":"The `Card` owner ID, only applicable for `owner` type `employee` cards.","example":"XMPL1234-000001"},"wallet_id":{"type":"string","description":"The `Wallet` ID, if not specified a reserved `Wallet` will be created for the added `Card`.","example":"c861cc24-6663-410f-8c78-73f886fff4ef"},"reserved_wallet_currency":{"$ref":"#/components/schemas/ISO4217SupportedCurrency","description":"The reserved `Wallet` currency, only required when adding a dedicated card.","example":"EUR"},"type":{"$ref":"#/components/schemas/AddCardType","description":"The type of the `Card`.","example":"PLASTIC"},"name":{"type":"string","description":"The logical name of the `Card` for a `company` card, ignored in case of `employee` card (the cardholder full name is used instead).","example":"CardName"},"card_label":{"type":"string","description":"A label for the `Card` (max 60 characters).","example":"CardLabel","maxLength":60},"emboss_line4":{"type":"string","description":"The emboss line 4 of the `Card`.","example":"Example Inc."},"address_id":{"type":"string","description":"The `Address` ID the `Card` has to be shipped to (if empty, the default shipping `Address` is used i.e. where `default_shipping` = `true`), only applicable for `PLASTIC` and `FUEL` cards.","example":"c861cc24-6663-410f-8c78-73f886fff4ef"},"vehicle_id":{"type":"string","description":"The `Vehicle` ID assigned to the `Card`, only valid for `FUEL` cards.","example":"c861cc24-6663-410f-8c78-73f886fff4ef"},"preset_id":{"type":"string","description":"The `cardRulePreset` ID assigned to the `Card`.","example":"c861cc24-6663-410f-8c78-73f886fff4ef"}},"required":["name","owner_public_id","owner_type","request_timestamp","type"]},"AddCardType":{"type":"string","enum":["PLASTIC","VIRTUAL","FUEL","GOOGLE_CARD","PLASTIC_CHARGE","VIRTUAL_CHARGE"]},"AddOrderCardOwnerType":{"type":"string","enum":["company","employee","expensecentre"]},"ISO4217SupportedCurrency":{"type":"string","description":"The [ISO 4217](https://www.six-group.com/en/products-services/financial-information/data-standards.html#scrollTo=maintenance-agency) code of the currency of the `Statement` to search for.","enum":["EUR","GBP","USD"],"example":"EUR"},"AccountIdentificationType":{"type":"string","enum":["SORT_CODE","ACCOUNT_NUMBER","IBAN"]},"AccountInfoContact":{"properties":{"type":{"$ref":"#/components/schemas/AccountIdentificationType","description":"The `type` of account identification.","example":"IBAN"},"identification":{"type":"string","description":"The account identification related to the type.","example":"GB00ABCD00000123456789"}}},"Contact":{"properties":{"id":{"type":"string","description":"The `Contact` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"name":{"type":"string","description":"The name of the `Contact`.","example":"John Doe"},"user_id":{"type":"string","description":"The ID of the `User` the bank details are assigned to (only available for `Contacts` of type `EMPLOYEE`).","example":"XMPL1234-000001"},"type":{"$ref":"#/components/schemas/ContactType","description":"The type of `Contact`.","example":"SUPPLIER"},"payment_scheme":{"type":"array","description":"The type of payment accepted by the `Contact`.","items":{"$ref":"#/components/schemas/PaymentSchema"},"uniqueItems":true},"account_info":{"type":"array","description":"The account info","items":{"$ref":"#/components/schemas/AccountInfoContact"}},"country":{"$ref":"#/components/schemas/ISO3166Country","description":"The [ISO 3166-1 alpha-3](https://www.iso.org/obp/ui/#search/code/) code of the country of the `Contact`.","example":"GBR"},"status":{"$ref":"#/components/schemas/ContactStatus","description":"The status of the `Contact`.","example":"SUGGESTED"},"creation_time":{"type":"string","description":"The date and time when the contact was created.","example":"2017-06-01T12:48:40Z"},"last_update_time":{"type":"string","description":"The date and time when the contact was last updated.","example":"2017-06-01T12:48:40Z"}}},"ContactStatus":{"type":"string","enum":["CREATED","SUGGESTED"]},"ContactType":{"type":"string","enum":["SUPPLIER","CLIENT","EMPLOYEE","ACCOUNT"]},"PaymentSchema":{"type":"string","enum":["FPS","SEPA","SEPA_INSTANT"]},"CreateContact":{"description":"Create `Contact` JSON parameters.","properties":{"name":{"type":"string","description":"The name of the `Contact`.","example":"John Doe"},"user_id":{"type":"string","description":"The ID of the `User` the bank details are assigned to (only available for `Contacts` of type `EMPLOYEE`).","example":"XMPL1234-000001"},"type":{"$ref":"#/components/schemas/ContactType","description":"The type of the `Contact`.","example":"SUPPLIER"},"account_info":{"type":"array","description":"The account info.","items":{"$ref":"#/components/schemas/AccountInfoContact"}},"country":{"$ref":"#/components/schemas/ISO3166Country","description":"The [ISO 3166-1 alpha-3](https://www.iso.org/obp/ui/#search/code/) code of the country of the `Contact`","example":"GBR"}},"required":["country","name","type"]},"DelegationFeature":{"type":"string","enum":["REQUEST_MONEY","REQUEST_PURCHASE","EXPENSE_REVIEW"]},"DelegationStatus":{"type":"string","enum":["ACTIVE","EXPIRED","SCHEDULED","DELETED"]},"OutOfOfficeDelegation":{"properties":{"id":{"type":"string","description":"A unique identifier for this `out_of_office` entry.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"delegator_id":{"type":"string","description":"The ID of the person assigning the `out_of_office`.","example":"XMPL1234-000001"},"delegate_id":{"type":"string","description":"The ID of the person covering for the delegator.","example":"XMPL1234-000002"},"from_date":{"type":"string","format":"date","description":"Defines when the out_of_office entry starts. fromDate included. (i.e. greater than or equal to) (Format:`yyyy-MM-dd`).","example":"2025-03-05"},"to_date":{"type":"string","format":"date","description":"Defines when the out_of_office entry ends. toDate included. (i.e. less than) (Format:`yyyy-MM-dd`).","example":"2025-03-07"},"features":{"type":"array","description":"The features of `out_of_office`.","items":{"$ref":"#/components/schemas/DelegationFeature"},"uniqueItems":true},"status":{"$ref":"#/components/schemas/DelegationStatus","description":"The work status of `out_of_office`.","example":"ACTIVE"}}},"CreateOutOfOfficeDelegation":{"description":"Create `out_of_office` JSON parameters.","properties":{"request_timestamp":{"type":"integer","format":"int64","description":"The epoch timestamp in millis. This is checked in Soldo. Requests with timestamp older than 5 seconds will be rejected.","example":1576850500000},"delegator_id":{"type":"string","description":"The ID of the person assigning the `out_of_office`.","example":"XMPL1234-000001"},"delegate_id":{"type":"string","description":"The ID of the person covering for the delegator.","example":"XMPL1234-000002"},"from_date":{"type":"string","description":"Defines when the out_of_office entry starts. fromDate included.(i.e. greater than or equal to) (Format: `yyyy-MM-dd`).","example":"2020-04-06"},"to_date":{"type":"string","description":"Defines when the out_of_office entry ends. toDate included.(i.e. less than) (Format: `yyyy-MM-dd`).","example":"2020-04-06"},"features":{"type":"array","description":"The features of `out_of_office`.","items":{"$ref":"#/components/schemas/DelegationFeature"}}},"required":["delegate_id","delegator_id","features","request_timestamp"]},"CreateExpenseCategory":{"description":"Add `ExpenseCategory` JSON parameters.","properties":{"code":{"type":"string","description":"The code of the `ExpenseCategory`.","example":123},"name":{"type":"string","description":"The name of the `ExpenseCategory`.","example":"category-one"},"description":{"type":"string","description":"The description of the `ExpenseCategory`.","example":"An expense category"},"tax_rate_id":{"type":"string","description":"The ID of the VAT Rate linked to the `ExpenseCategory`.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"enabled":{"type":"boolean","description":"it determines whether the `ExpenseCategory` is visible on the transaction detail.","example":true},"merchant_categories":{"type":"array","description":"A list of merchant categories this `ExpenseCategory` is auto-assigned to.","items":{"$ref":"#/components/schemas/MerchantCategory"}},"expense_type":{"$ref":"#/components/schemas/ExpenseType","description":"The type of expense this `ExpenseCategory` is assigned to.","example":"company"}},"required":["expense_type","name"]},"ExpenseReviewProcess":{"properties":{"id":{"type":"string","description":"The `ExpenseReviewProcess` id.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"name":{"type":"string","description":"The name of the`ExpenseReviewProcess`.","example":"EXPENSE REVIEW PROCESS"},"description":{"type":"string","description":"A textual description of the `ExpenseReviewProcess`.","example":"EXPENSE REVIEW PROCESS DESCRIPTION"},"steps_count":{"type":"integer","format":"int32","description":"The total number of approval steps.","example":2},"priority":{"type":"integer","format":"int32","description":"The order of priority in which the `ExpenseReviewProcess` will be executed.","example":2},"status":{"$ref":"#/components/schemas/ExpenseReviewProcessStatus","description":"The status of `ExpenseReviewProcess`.","example":"ACTIVE"},"conditions":{"type":"array","description":"The conditions a transaction needs to match in order to be included in the `ExpenseReviewProcess`.","items":{"$ref":"#/components/schemas/ExpenseReviewProcessCondition"}},"steps":{"type":"array","description":"The approval steps a transaction needs to go through in order to be reviewed.","items":{"$ref":"#/components/schemas/ExpenseReviewProcessStep"}}},"required":["conditions","description","name","status","steps","steps_count"]},"ExpenseReviewProcessAmountCondition":{"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/ExpenseReviewProcessComparator","description":"The logical operator to be used in relationship to the transaction amount.","example":"LOWER_EQUAL"}},"required":["amount","operator"]},"ExpenseReviewProcessAutomationRule":{"properties":{"expense_status":{"$ref":"#/components/schemas/ExpenseReviewProcessStepStatus","description":"The status of the expense in case the conditions of the automation rules are satisfied.","example":"PARTIALLY_APPROVED"},"required_info":{"type":"boolean","default":"false","description":"A boolean to define whether a transaction should have all the required info (as defined on the Reminders feature) completed.","example":true},"amount_condition":{"$ref":"#/components/schemas/ExpenseReviewProcessAmountCondition","description":"A condition based on the transaction amount."}},"required":["expense_status","required_info"]},"ExpenseReviewProcessComparator":{"type":"string","enum":["HIGHER_EQUAL","LOWER_EQUAL"]},"ExpenseReviewProcessCondition":{"properties":{"type":{"$ref":"#/components/schemas/ExpenseReviewProcessConditionType","description":"The type of the condition.","example":"USER"},"value":{"type":"array","description":"One or more values which identify the type of condition. In case of type `OUT_OF_PLATFORM_COMPANY`, `OUT_OF_PLATFORM_PERSONAL` and `PURCHASE` the value must be `ALL`. In case of `EXPENSE_TYPE` the accepted values are: `COMPANY`, `PERSONAL`, `TRAVEL_AND_ENTERTAINMENT`. In case of `ONLINE_ADS_CARD` and `SUBSCRIPTION_CARD` it’s the ID of the corresponding card. In all the other cases it’s the public ID of the resource as returned by the corresponding endpoint.","example":["7bf79328-a7ae-4222-aa54-091ff7f429a7","2d65bd5e-3fdf-4002-b166-bde7fb8863fa"],"items":{"type":"string"}}},"required":["type","value"]},"ExpenseReviewProcessConditionType":{"type":"string","enum":["COMPANY_CARD","COMPANY_WALLET","EXPENSE_CATEGORY","EXPENSE_TYPE","MAIN_WALLET","ONLINE_ADS_CARD","OUT_OF_PLATFORM_COMPANY","OUT_OF_PLATFORM_PERSONAL","PURCHASE","SUBSCRIPTION_CARD","TAG","USER","USER_CARD"]},"ExpenseReviewProcessReviewerInfo":{"properties":{"id":{"type":"array","description":"The ID of the reviewer as returned by the corresponding endpoint (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"}}},"required":["id"]},"ExpenseReviewProcessReviewerType":{"type":"string","enum":["LINE_MANAGER","ROLE","USER"]},"ExpenseReviewProcessStatus":{"type":"string","enum":["ACTIVE","INACTIVE"]},"ExpenseReviewProcessStep":{"properties":{"step_number":{"type":"integer","format":"int32","default":"1","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.","example":2,"minimum":1},"reviewer_type":{"$ref":"#/components/schemas/ExpenseReviewProcessReviewerType","description":"The type of reviewer who can review this step.","example":"USER"},"reviewer_info":{"$ref":"#/components/schemas/ExpenseReviewProcessReviewerInfo","description":"One or more IDs to identify who can review this step (only required in case of reviewer of type `ROLE` and `USER`)."},"automation_rule":{"$ref":"#/components/schemas/ExpenseReviewProcessAutomationRule","description":"An automation to automatically review the step when certain conditions are met."}},"required":["reviewer_type","step_number"]},"ExpenseReviewProcessStepStatus":{"type":"string","enum":["APPROVED","PARTIALLY_APPROVED","DECLINED"]},"CreateExpenseReviewProcess":{"description":"Create `ExpenseReviewProcess` JSON parameters.","properties":{"name":{"type":"string","description":"The name of the `ExpenseReviewProcess`.","example":"EXPENSE REVIEW PROCESS"},"description":{"type":"string","description":"The description of the `ExpenseReviewProcess`.","example":"EXPENSE REVIEW PROCESS DESCRIPTION"},"conditions":{"type":"array","description":"The conditions a transaction needs to match in order to be included in the `ExpenseReviewProcess`.","items":{"$ref":"#/components/schemas/ExpenseReviewProcessCondition"}},"steps":{"type":"array","description":"The approval steps a transaction needs to go through in order to be reviewed.","items":{"$ref":"#/components/schemas/ExpenseReviewProcessStep"}}},"required":["conditions","description","name","steps"]},"CreateExpenseReviewConfiguration":{"description":"Create conf JSON parameters.","properties":{"request_timestamp":{"type":"integer","format":"int64","description":"The epoch timestamp in millis. This is checked in Soldo. Requests with timestamp older than 5 seconds will be rejected.","example":1576850500000},"start_date":{"type":"string","description":"The starting date from which the expenses can be reviewed.","example":"2017-06-01T12:48:40Z"},"transaction_categories":{"type":"array","description":"It determines the filter by category of the transaction.","items":{"$ref":"#/components/schemas/ExpenseTransactionCategoryInput"},"uniqueItems":true},"activity_groups":{"type":"array","description":"It determines the filter by types of cards whose transactions are considered as expenses to be reviewed.","items":{"$ref":"#/components/schemas/ExpenseConfigurationActivityGroup"},"uniqueItems":true},"policy_url":{"type":"string","description":"The url of the company spending policy.","example":"https://www.policy.pdf"},"start_date_type":{"$ref":"#/components/schemas/ExpenseDateType","description":"It determines the filter by the type of date, multiple statuses can be included.","example":"SETTLEMENT"}},"required":["activity_groups","policy_url","request_timestamp","start_date"]},"ExpenseTransactionCategoryInput":{"type":"string","enum":["Payment"]},"CreateGroup":{"description":"Create `Group` JSON parameters.","properties":{"name":{"type":"string","description":"The name of the `Group`.","example":"HR"},"custom_reference_id":{"type":"string","description":"The `Group` reference in an external system.","example":"hr-division-0001"},"note":{"type":"string","description":"Any notes about the `Group`.","example":"division"},"type":{"$ref":"#/components/schemas/GroupType","description":"The `Group`'s type.","example":"DIVISION"}}},"TagDictionary":{"properties":{"id":{"type":"string","description":"The ID of the `List`.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"dictionary":{"type":"string","description":"The name of the `List`.","example":"ExampleTagDictionary"},"visible":{"type":"boolean","description":"It determines whether the `List` is active.","example":true},"creation_time":{"type":"string","description":"The date and time when the `List` was created.","example":"2017-06-01T12:48:40Z"},"last_update":{"type":"string","description":"The date and time when the `List` was last updated.","example":"2017-06-01T12:48:40Z"},"roles":{"type":"array","description":"The list of `Roles` that can view the items in the transaction details.(sortable: no).","example":["7bf79328-a7ae-4222-aa54-091ff7f429a7","2d65bd5e-3fdf-4002-b166-bde7fb8863fa"],"items":{"type":"string"}},"users":{"type":"array","description":"The list of `Users` that can view the items in the transaction details. (sortable: no).","example":["XMPL1234-000001","XMPL1234-000002","XMPL1234-000003"],"items":{"type":"string"}},"is_unique_select_tag":{"type":"boolean","description":"It determines whether multiple tags of the `List` can be selected.","example":false}}},"AddAssignees":{"description":"Add `Subscription` assignees JSON parameters.","properties":{"add_assignees":{"type":"array","description":"List of new `User` IDs to add as assignees.","example":["XMPL1234-000001","XMPL1234-000002","XMPL1234-000003"],"items":{"type":"string"}}},"required":["add_assignees"]},"CreatePurchase":{"description":"Create `Purchase` JSON parameters.","properties":{"title":{"type":"string","description":"The name of the `Purchase`.","example":"Tech book"},"assignee_id":{"type":"string","description":"The ID of the `User` assigned to the `Purchase`.","example":"XMPL1234-000003"},"amount":{"type":"number","description":"The maximum spendable amount of the `Purchase`.","example":10.25},"description":{"type":"string","description":"The description of the `Purchase`.","example":"A purchase to approve"},"wallet_id":{"type":"string","description":"The ID of the `Wallet` the money are taken from, the funding source of the `Purchase`.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"notes":{"type":"string","description":"The notes of the `Purchase`.","example":"Notes about the purchase request"},"max_tx_number":{"type":"integer","format":"int32","default":"1","description":"The total number of `Transactions` the temporary virtual `Card` can make.","example":3}},"required":["amount","assignee_id","description","max_tx_number","title","wallet_id"]},"PaymentMethod":{"type":"string","enum":["CARD","BANK_TRANSFER"]},"RequestApproverInfo":{"properties":{"id":{"type":"string","description":"The ID of the `User` who approves/rejects the expense.","example":"XMPL1234-000003"},"name":{"type":"string","description":"The name of the `User` who approves/rejects the expense.","example":"JOHNDOE"}}},"RequestPayload":{"discriminator":{"propertyName":"type"},"properties":{"type":{"$ref":"#/components/schemas/RequestType","description":"The type of the `Request`.","example":"GOODS_OR_SERVICES"},"id":{"type":"string","description":"The `Request` ID (sortable: no).","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"name":{"type":"string","description":"The name of the `Request` (sortable: no).","example":"Supplier name"},"description":{"type":"string","description":"The description of the `Request` (sortable: no).","example":"Example description"},"requester":{"type":"string","description":"The ID of the `User` that makes the `Request` (sortable: no).","example":"XMPL1234-000001"},"request_process_id":{"type":"string","description":"The `ExpenseReviewProcess` ID of the `Request` (sortable: no).","example":"135fdb6c-2e77-4fc0-a79f-2453fde75ef7"},"status":{"$ref":"#/components/schemas/RequestStatus","description":"The status of the `Request` (sortable: no).","example":"APPROVED"},"amount":{"type":"number","description":"The amount of the `Request` (sortable: no).","example":10.25},"currency":{"$ref":"#/components/schemas/ISO4217Currency","description":"The [ISO 4217](https://www.six-group.com/en/products-services/financial-information/data-standards.html#scrollTo=maintenance-agency) code of the currency of `Request`.","example":"EUR"},"has_attachments":{"type":"boolean","description":"It determines whether the `Request` has one or more attachments (sortable: no).","example":false},"creation_time":{"type":"string","description":"The date and time when the `Request` was created (sortable: yes).","example":"2017-06-01T12:48:40Z"},"last_update_time":{"type":"string","description":"The date and time when the `Request` was last updated (sortable: yes).","example":"2017-06-01T12:48:40Z"},"note":{"type":"string","description":"The comments of the `Request` (sortable: no).","example":"Requester note"},"review_timeline":{"type":"array","description":"The timeline review step of the `Request` (sortable: no).","items":{"$ref":"#/components/schemas/RequestStepInfo"}}}},"RequestStatus":{"type":"string","enum":["APPROVED","DECLINED","PENDING","IDLE","DELETED"]},"RequestStepInfo":{"properties":{"step_number":{"type":"integer","format":"int32","description":"The number of the step that approves/rejects the expense.","example":2},"reviewer_type":{"$ref":"#/components/schemas/ReviewProcessReviewerType","description":"The type of review of the step that approves/rejects the expense.","example":"ROLE"},"status":{"$ref":"#/components/schemas/ReviewProcessStepStatus","description":"The status of the step that approves/rejects the expense.","example":"APPROVED"},"date":{"type":"string","description":"The timestamp of the step that approves/rejects the expense.","example":"2025-12-24T23:00:00Z"},"reviewer_info":{"type":"array","description":"The name of the step that approves/rejects the expense.","items":{"$ref":"#/components/schemas/RequestApproverInfo"}},"automatic_review":{"type":"boolean","description":"The name of the step that approves/rejects the expense.","example":false}}},"RequestType":{"type":"string","enum":["GOODS_OR_SERVICES","FUNDS","TRIP"]},"ResponseFunds":{"allOf":[{"$ref":"#/components/schemas/RequestPayload"},{"type":"object","properties":{"card_id":{"type":"string","description":"The ID of the Card of Request..."}}}]},"ResponseGoodsServices":{"allOf":[{"$ref":"#/components/schemas/RequestPayload"},{"type":"object","properties":{"payment_method":{"$ref":"#/components/schemas/PaymentMethod","description":"The method of payment of the `Request` (sortable: no).","example":"Temporary card"},"number_transactions":{"type":"integer","format":"int32","description":"the number of transactions the `Request` was created (sortable: yes).","example":2}}}]},"ResponseTrip":{"allOf":[{"$ref":"#/components/schemas/RequestPayload"},{"type":"object","properties":{"card_id":{"type":"string","description":"The ID of the `Card` of `Request` where funds are transferred(traveller card) (sortable: no).","example":"XMPL1234-000001"},"destination":{"type":"string","description":"The destination of the `Request` for the `BusinessTrip` type (sortable: no).","example":"monte fato"},"traveller":{"type":"string","description":"The ID of the traveller `User`of the `Request` assigned to the type `BusinessTrip`.","example":"XMPL1234-000001"},"date_from":{"type":"string","description":"The start date of the `Request` for the `BusinessTrip` type (sortable: no).","example":"2017-06-01T12:48:40Z"},"date_to":{"type":"string","description":"The end date of the `Request` for the `BusinessTrip` type (sortable: no).","example":"2017-06-01T12:48:40Z"},"expense_allocation":{"type":"array","description":"The list of `ExpenseAllocation` of the `Request` for the `BusinessTrip` type (sortable: no).","items":{"$ref":"#/components/schemas/UpdateTripExpense"}},"tags":{"type":"array","description":"The IDs of the `Tag` and related `Dictionary` of the `Request` for the `BusinessTrip` type (sortable: no)","items":{"$ref":"#/components/schemas/BusinessTripTag"}}}}]},"ReviewProcessReviewerType":{"type":"string","enum":["LINE_MANAGER","ROLE","AUTOMATIC","USER"]},"ReviewProcessStepStatus":{"type":"string","enum":["APPROVED","PARTIALLY_APPROVED","DECLINED"]},"UpdateTripExpense":{"description":"Expense allocation: expense_category_id and description are mutually exclusive: provide expense_category_id (for an existing expense category) or description (for a custom expense), but not both.","properties":{"expense_category_id":{"type":"string","description":"The ID of the `ExpenseCategory` related to this `BusinessTripExpense`. Required if description is not provided. Mutually exclusive with `expense_category_id`: provide either `description` (for a custom expense) or `expense_category_id` (for an existing expense category), but not both.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"spend_period":{"$ref":"#/components/schemas/BusinessTripExpenseSpendPeriod","description":"The spend period of the `BusinessTripExpense`.","example":"BEFORE_TRIP"},"amount":{"type":"number","description":"The amount of the `BusinessTripExpense`.","example":10.25},"amount_currency":{"$ref":"#/components/schemas/ISO4217Currency","description":"The currency of the amount of the `BusinessTripExpense`.","example":"EUR"},"description":{"type":"string","description":"The custom name of the `BusinessTripExpense`. Required if expenseCategoryId is not provided. Mutually exclusive with `expense_category_id`: provide either `description` (for a custom expense) or `expense_category_id` (for an existing expense category), but not both.","example":"CUSTOM_EXPENSE"}}},"CreateRequestFunds":{"allOf":[{"$ref":"#/components/schemas/CreateRequestPayload"},{"type":"object","properties":{"destination_card_id":{"type":"string","description":"The ID of the `Card` of `Request` where funds are transferred required for the `Funds` type (sortable: no).","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"description":{"type":"string","description":"The description of the `Request`.","example":"Example description"}}}],"required":["amount","currency","description","destination_card_id","name","request_process_id","request_timestamp","requester","type"]},"CreateRequestGoodsOrServices":{"allOf":[{"$ref":"#/components/schemas/CreateRequestPayload"},{"type":"object","properties":{"description":{"type":"string","description":"The description of the `Request` (sortable: no).","example":"Example description"},"number_transactions":{"type":"integer","format":"int32","description":"the number of transactions the `Request` was created (sortable: yes).","example":2}}}],"required":["amount","currency","description","name","request_process_id","request_timestamp","requester","type"]},"CreateRequestPayload":{"discriminator":{"propertyName":"type"},"properties":{"type":{"$ref":"#/components/schemas/RequestType","description":"The type of the `Request`."},"name":{"type":"string","description":"The name of the `Request` (sortable: no).","example":"Supplier name"},"request_process_id":{"type":"string","description":"The process id of the `Request` (sortable: no).","example":"135fdb6c-2e77-4fc0-a79f-2453fde75ef7"},"requester":{"type":"string","description":"The ID of the `User` that makes the `Request` (sortable: no).","example":"XMPL1234-000001"},"amount":{"type":"number","description":"The total amount of the `Request` (sortable: no).","example":10.25},"currency":{"$ref":"#/components/schemas/ISO4217Currency","description":"The currency of the total amount of the `Request` (sortable: no).","example":"EUR"},"note":{"type":"string","description":"The requester's note of the `Request` (sortable: no).","example":"Requester note"},"request_timestamp":{"type":"integer","format":"int64","description":"The epoch timestamp in millis. This is checked in Soldo. Requests with timestamp older than 5 seconds will be rejected.","example":1576850500000}},"required":["amount","currency","name","request_process_id","request_timestamp","requester","type"]},"CreateRequestTrip":{"allOf":[{"$ref":"#/components/schemas/CreateRequestPayload"},{"type":"object","properties":{"card_id":{"type":"string","description":"The ID of the `Card` of `Request` where funds are transferred(traveller card) (sortable: no).","example":"XMPL1234-000001"},"destination":{"type":"string","description":"The destination of the `Request` for the `BusinessTrip` type (sortable: no).","example":"monte fato"},"description":{"type":"string","description":"The description of the `Request` (sortable: no).","example":"Example description"},"traveller":{"type":"string","description":"The ID of the traveller `User` of the `Request` assigned to the type `BusinessTrip`.","example":"XMPL1234-000001"},"date_from":{"type":"string","description":"The start date of the `Request` for the `BusinessTrip` type (sortable: no).","example":"2017-06-01T12:48:40Z"},"date_to":{"type":"string","description":"The end date of the `Request` for the `BusinessTrip` type (sortable: no).","example":"2017-06-01T12:48:40Z"},"expense_allocation":{"type":"array","description":"The list of `ExpenseAllocation` of the `Request` for the `BusinessTrip` type (sortable: no).","items":{"$ref":"#/components/schemas/BusinessTripExpense"}},"tags":{"type":"array","description":"The IDs of the `Tag` and related `Dictionary` of the `Request` for the `BusinessTrip` type (sortable: no)","items":{"$ref":"#/components/schemas/BusinessTripTag"}}}}],"required":["amount","card_id","currency","date_from","date_to","destination","expense_allocation","name","request_process_id","request_timestamp","requester","traveller","type"]},"Configuration":{"properties":{"resource_type":{"$ref":"#/components/schemas/ResourceSetResourceType","description":"The type of resource for which the scope is defined.","example":"GROUP"},"scope":{"$ref":"#/components/schemas/ResourceSetScope","description":"The scope defined for the resource.","example":"ALL"},"resource_ids":{"type":"array","description":"The list of resource IDs belonging to the scope, only in case of scope of type `LIST`.","example":["7bf79328-a7ae-4222-aa54-091ff7f429a7","2d65bd5e-3fdf-4002-b166-bde7fb8863fa"],"items":{"type":"string"}}}},"ResourceSet":{"properties":{"id":{"type":"string","description":"The `ResourceSet` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"name":{"type":"string","description":"The name of the `ResourceSet`.","example":"Resource set 01"},"description":{"type":"string","description":"The description of the `ResourceSet`.","example":"This is a resource set"},"configuration":{"type":"array","description":"The configuration of the `ResourceSet`.","items":{"$ref":"#/components/schemas/Configuration"}},"creation_time":{"type":"string","description":"The date and time when the `ResourceSet` was created.","example":"2017-06-01T12:48:40Z"},"last_update_time":{"type":"string","description":"The date and time when the `ResourceSet` was last updated.","example":"2017-06-01T12:48:40Z"}}},"ResourceSetResourceType":{"type":"string","enum":["MAIN_WALLET","COMPANY_WALLET","USER","COMPANY_CARD","GROUP"]},"ResourceSetScope":{"type":"string","enum":["SELF","LIST","ALL","NONE"]},"CreateResourceSet":{"description":"Create `ResourceSet` JSON parameters.","properties":{"name":{"type":"string","description":"The name of the `ResourceSet`.","example":"Resource set 01"},"description":{"type":"string","description":"The description of the `ResourceSet`.","example":"This is a resource set"},"configuration":{"type":"array","description":"The configuration of the `ResourceSet`.","items":{"$ref":"#/components/schemas/Configuration"}}},"required":["configuration","name"]},"GroupResource":{"description":"Delete Resource `Group` JSON parameters.","properties":{"id":{"type":"string","description":"The ID of either `User`, `Wallet` or `Card` `Group`resource.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"type":{"$ref":"#/components/schemas/GroupResourceType","description":"The type of `Group`resource.","example":"USER"}}},"GroupResourceType":{"type":"string","enum":["USER","WALLET","CARD"]},"Tag":{"properties":{"id":{"type":"string","description":"The `Tag` ID (sortable: no).","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"},"dictionary_id":{"type":"string","description":"The `List` ID (sortable: no).","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"dictionary":{"type":"string","description":"The name of the `List` where the `Tag` is listed (sortable: no).","example":"ExampleTagDictionary"},"tag":{"type":"string","description":"The name of the `Tag` (sortable: yes).","example":"tx-label"},"description":{"type":"string","description":"The description of the `Tag` (sortable: no).","example":"Label to mark transactions"},"visible":{"type":"boolean","description":"It determines whether the `Tag` is visible in the `Transaction` detail (sortable: yes).","example":true},"code":{"type":"string","description":"The code of the `Tag` (sortable: no)."},"percentage":{"type":"number","format":"double","deprecated":true,"description":"Percentage value: valid for TAX_RATE type only (sortable: no). Deprecated, only for backward compatibility."}}},"TagItems":{"properties":{"tags":{"type":"array","description":"The list of `Tag` resources.","example":["7bf79328-a7ae-4222-aa54-091ff7f429a7","2d65bd5e-3fdf-4002-b166-bde7fb8863fa"],"items":{"$ref":"#/components/schemas/Tag"}}}},"NewTagBulk":{"description":"New `Tag` bulk JSON parameters.","properties":{"tags":{"type":"array","description":"The list of `Tag` resources to create in bulk.","example":["7bf79328-a7ae-4222-aa54-091ff7f429a7","2d65bd5e-3fdf-4002-b166-bde7fb8863fa"],"items":{"$ref":"#/components/schemas/NewTagBulkItem"}}}},"NewTagBulkItem":{"properties":{"tag":{"type":"string","description":"The name of the `Tag`.","example":"tx-label"},"description":{"type":"string","description":"The description of the `Tag`. If needed to support special characters, provide the character encoding in the `Content-Type` header (e.g. `application/x-www-form-urlencoded ; charset=utf-8`).","example":"Label to mark transactions"},"code":{"type":"string","description":"The code of the `Tag`. If needed to support special characters, provide the character encoding in the `Content-Type` header (e.g. `application/x-www-form-urlencoded ; charset=utf-8`).","example":"CODE tag"}},"required":["tag"]},"CreateVatRate":{"description":"Add `VatRate` JSON parameters.","properties":{"code":{"type":"string","description":"The code of the VATRate.","example":"code-vat-11"},"name":{"type":"string","description":"The name of the VATRate.","example":"Tax 11"},"description":{"type":"string","description":"the description of the VATRate.","example":"Number 11 of Tax code"},"percentage":{"type":"number","format":"double","description":"The percentage value of the VATRate.","example":"something"},"enabled":{"type":"boolean","description":"the VATRate is visible in the transaction detail.","example":true}},"required":["name","percentage"]},"CustomExportTransactionStatus":{"type":"string","enum":["SUCCESS","FAILED"]},"ExportedCustomTransaction":{"properties":{"exported_transactions":{"type":"array","items":{"$ref":"#/components/schemas/TransactionCustomExported"}}}},"TransactionCustomExported":{"properties":{"id":{"type":"string","description":"The `TransactionCustomExport` ID","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"transaction_id":{"type":"string","description":"The `Transaction` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"product":{"type":"string","description":"A product that exported list of `Transaction`","example":"SAP"},"export_timestamp":{"type":"string","description":"The date and time when the `Transaction` was exported.","example":"2017-06-01T12:48:40Z"},"status":{"$ref":"#/components/schemas/CustomExportTransactionStatus","description":"The result of the `TransactionCustomExport` of `Transaction`","example":"SUCCESS"}}},"CreateTransactionCustomExport":{"description":"Add `TransactionCustomExport` JSON parameters.","properties":{"transaction_ids":{"type":"array","description":"A list of `Transaction` Ids","example":["4bf79328-a7ae-4222-aa54-091ff7f429a7"],"items":{"type":"string"}},"product":{"type":"string","description":"A product that exported list of `Transaction`","example":"SAP"}},"required":["product","transaction_ids"]},"CreateVehicle":{"description":"Create vehicle JSON parameters.","properties":{"number_plate":{"type":"string","description":"The plate number of the `Vehicle`.","example":"AA000BB","maxLength":9},"description":{"type":"string","description":"The description of the `Vehicle`.","example":"Employee electric vehicle","maxLength":30,"pattern":"^[^<>=]{0,30}$"},"vat_deductible":{"$ref":"#/components/schemas/VatDeductibilityPercentage","description":"The VAT deductibility rate.","example":40},"fuel_type":{"$ref":"#/components/schemas/FuelType","description":"The fuel type of the `Vehicle`.","example":"PETROL"},"reimbursement_rate":{"type":"number","description":"The rate to apply for a `MileageReimbursement`, measured in main `Wallet` currency per km.","example":0.45}},"required":["description","fuel_type","number_plate","vat_deductible"]},"AddWalletOrder":{"description":"Add `Wallet` JSON parameters.","properties":{"request_timestamp":{"type":"integer","format":"int64","description":"The epoch timestamp in millis. This is checked in Soldo. Requests with timestamp older than 5 seconds will be rejected.","example":1576850500000},"name":{"type":"string","description":"The name of the `Wallet`.","example":"John Doe"},"currency":{"$ref":"#/components/schemas/ISO4217SupportedCurrency","description":"The currency of the `Wallet`.","example":"EUR"},"owner_type":{"$ref":"#/components/schemas/AddWalletOwnerType","description":"The type of the owner of the `Wallet`.","example":"company"}},"required":["currency","name","request_timestamp"]},"AddWalletOwnerType":{"type":"string","enum":["company"]},"WalletsToTransfer":{"description":"The `Wallet` JSON parameters.","properties":{"walletIds":{"type":"array","description":"A list of `Wallet` IDs.","example":["7bf79328-a7ae-4222-aa54-091ff7f429a7","2d65bd5e-3fdf-4002-b166-bde7fb8863fa"],"items":{"type":"string"}}}},"WebhookSubscription":{"properties":{"id":{"type":"string","format":"uuid","description":"The `WebhookSubscription` ID."},"webhook_url":{"type":"string","description":"The URL of `WebhookSubscription`.","example":"https://your_domain.com/xx/xx"},"enabled_events":{"type":"array","description":"The list of subscribed events.","items":{"$ref":"#/components/schemas/WebhookEventName"},"uniqueItems":true},"description":{"type":"string","description":"A custom description of the `WebhookSubscription`.","example":"Report updates"},"active":{"type":"boolean","description":"The status of the `WebhookSubscription`.","example":true},"creation_date":{"type":"string","description":"The date and time when the `WebhookSubscription` was created (sortable: yes).","example":"2017-06-01T12:48:40Z"},"last_update":{"type":"string","description":"The last date and time when the `WebhookSubscription` was last updated (sortable: yes).","example":"2017-06-01T12:48:40Z"}}},"CreateWebhookSubscription":{"description":"Create `WebhookSubscription` JSON parameters.","properties":{"webhook_url":{"type":"string","description":"The url of the `WebhookSubscription`.","example":"https://your_domain.com/xx/xx"},"enabled_events":{"type":"array","description":"The list of the `WebhookSubscription` enabled events.","example":["card_activated"],"items":{"$ref":"#/components/schemas/WebhookEventName"}},"description":{"type":"string","description":"The description of the `WebhookSubscription`.","example":"Google Ads Campaign"},"active":{"type":"boolean","description":"The status of the `WebhookSubscription` (if `false`, notifications are not sent).","example":false}},"required":["active","enabled_events","webhook_url"]},"ApprovedRequestFunds":{"allOf":[{"$ref":"#/components/schemas/ApprovedRequestPayload"},{"type":"object","properties":{"amount":{"type":"number","description":"The amount of the `Request` (sortable: no).","example":10.25},"currency":{"$ref":"#/components/schemas/ISO4217Currency","description":"The currency of the amount of the `Request`.","example":"EUR"}}}],"required":["approver","source_wallet_public_id","type"]},"ApprovedRequestGoodsOrServices":{"allOf":[{"$ref":"#/components/schemas/ApprovedRequestPayload"},{"type":"object","properties":{"number_transactions":{"type":"integer","format":"int32","description":"the number of transactions the `Request` was created (sortable: yes).","example":2},"amount":{"type":"number","description":"The amount of the `Request` (sortable: no).","example":10.25},"currency":{"$ref":"#/components/schemas/ISO4217Currency","description":"The currency of the amount of the `Request`.","example":"EUR"}}}],"required":["approver","number_transactions","source_wallet_public_id","type"]},"ApprovedRequestPayload":{"discriminator":{"propertyName":"type"},"properties":{"type":{"$ref":"#/components/schemas/RequestType","description":"The type of the `Request`."},"source_wallet_public_id":{"type":"string","description":"The ID of the `Wallet` of `Request`, the request type is `Funds` or `BusinessTrip` (sortable: no).","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"note":{"type":"string","description":"The supervisor's note of the `Request` (sortable: no).","example":"Requester note"},"approver":{"type":"string","description":"The requester's note of the `Request` (sortable: no).","example":"XMPL1234-000001"}},"required":["approver","source_wallet_public_id","type"]},"ApprovedRequestTrip":{"allOf":[{"$ref":"#/components/schemas/ApprovedRequestPayload"},{"type":"object","properties":{"pre_action":{"$ref":"#/components/schemas/PreAction","description":"The action to be performed pre `BusinessTrip`(sortable: no)."},"post_action":{"$ref":"#/components/schemas/PostAction","description":"The action to be performed post the `BusinessTrip` (sortable: no)."},"expense_allocation":{"type":"array","description":"The list of `ExpenseAllocation` only for type `BusinessTrip` (sortable: no).","items":{"$ref":"#/components/schemas/BusinessTripExpense"}},"money_transfer_mode":{"$ref":"#/components/schemas/BusinessTripMoneyTransferMode","description":"The `BusinessTrip` money transfer mode."}}}],"required":["approver","money_transfer_mode","post_action","pre_action","source_wallet_public_id","type"]},"AssignedUserRoles":{"properties":{"id":{"type":"string","description":"The `User` ID.","example":"XMPL1234-000001"},"roles":{"type":"array","description":"The list of `UserRole` of the `User`.","items":{"$ref":"#/components/schemas/UserRole"}}}},"UpdateUserRoleAssignment":{"description":"Remove `Role` from `User` JSON parameters.","properties":{"name":{"type":"string","description":"The name of the `Role`.","example":"superAdmin"},"description":{"type":"string","description":"The description of the `Role`.","example":"The SuperAdmin role"},"scope":{"type":"string","description":"The name of the scope.","example":"ALL"}}},"Role":{"properties":{"id":{"type":"string","description":"The ID of the `Role`.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"name":{"type":"string","description":"The name of the `Role`.","example":"superAdmin"},"description":{"type":"string","description":"The description of the `Role`.","example":"The SuperAdmin role"},"category":{"type":"string","description":"The category of the `Role`.","example":"The SuperAdmin role"},"scopes":{"type":"array","description":"The scopes of the `Role`.","example":["ALL"],"items":{"type":"string"}}}},"UserRoles":{"properties":{"total":{"type":"integer","format":"int32","description":"It represents the total number of available items in the list.","example":168},"results":{"type":"array","items":{"$ref":"#/components/schemas/Role"}}}},"BusinessTripItem":{"properties":{"id":{"type":"string","description":"The `BusinessTrip` ID (sortable: no).","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"name":{"type":"string","description":"The name of the `BusinessTrip` (sortable: no).","example":"There and back again"},"description":{"type":"string","description":"The description of the `BusinessTrip` (sortable: no).","example":"EXAMPLE BUSINESS TRIP DESCRIPTION"},"destination":{"type":"string","description":"The destination of the `BusinessTrip` (sortable: no)."},"date_from":{"type":"string","description":"The start date of the `BusinessTrip` (sortable: no)."},"date_to":{"type":"string","description":"The end date of the `BusinessTrip` (sortable: no)."},"author_user_id":{"type":"string","description":"The ID of the `User` that created the `BusinessTrip` (sortable: no).","example":"XMPL1234-000001"},"approver_user_id":{"type":"string","description":"The ID of the `User` who approved the `BusinessTrip` (sortable: no).","example":"XMPL1234-000003"},"traveller_user_id":{"type":"string","description":"The ID of the traveller `User` assigned to the `BusinessTrip` (sortable: no).","example":"XMPL1234-000003"},"traveller_card_id":{"type":"string","description":"The ID of the `Card` where to transfer funds before and during the `BusinessTrip` (sortable: no).","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"},"money_transfer_mode":{"$ref":"#/components/schemas/BusinessTripMoneyTransferMode","description":"The mode of the money transfer before and during the `BusinessTrip` (sortable: no).","example":"SPLIT"},"status":{"$ref":"#/components/schemas/BusinessTripStatus","description":"The status of the `BusinessTrip` (sortable: no).","example":"ONGOING"},"purchase_state":{"$ref":"#/components/schemas/BusinessTripPurchaseStatus","description":"The purchase status of the `BusinessTrip` (sortable: no).","example":"ACTIVE"},"total_amount":{"type":"number","description":"The total amount of the `BusinessTrip` (sortable: no).","example":10.25},"total_amount_currency":{"$ref":"#/components/schemas/ISO4217Currency","description":"The currency of the total amount of the `BusinessTrip` (sortable: no).","example":"EUR"},"received_amount":{"type":"number","description":"The total amount already sent to the `Card` related to this `BusinessTrip` (sortable: no)."},"received_amount_currency":{"$ref":"#/components/schemas/ISO4217Currency","description":"The currency of the total amount already sent to the `Card` related to this `BusinessTrip` (sortable: no).","example":"EUR"},"scheduled_amount":{"type":"number","description":"The total amount still to send to the `Card` related to this `BusinessTrip` (sortable: no)."},"scheduled_amount_currency":{"$ref":"#/components/schemas/ISO4217Currency","description":"The currency of the total amount still to send to the `Card` related to this `BusinessTrip` (sortable: no).","example":"EUR"},"pre_action":{"$ref":"#/components/schemas/PreAction","description":"The action to be performed pre `BusinessTrip`(sortable: no)."},"post_action":{"$ref":"#/components/schemas/PostAction","description":"The action to be performed post the `BusinessTrip` (sortable: no)."},"wallet_id":{"type":"string","description":"The ID of the `Wallet` the money are taken from, the funding source of the `BusinessTrip` (sortable: no).","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"},"creation_time":{"type":"string","description":"The date and time when the `BusinessTrip` was created (sortable: yes).","example":"2017-06-01T12:48:40Z"},"last_update_time":{"type":"string","description":"The date and time when the `BusinessTrip` was last updated (sortable: yes).","example":"2017-06-01T12:48:40Z"}}},"BusinessTrips":{"properties":{"total":{"type":"integer","format":"int32","description":"It represents the total number of available items in the list.","example":168},"pages":{"type":"integer","format":"int32","description":"It represents the total number of available pages.","example":7},"page_size":{"type":"integer","format":"int32","description":"It represents the number of items per page.","example":25},"current_page":{"type":"integer","format":"int32","description":"It indicates the current page (the counter starts from zero).","example":0},"results_size":{"type":"integer","format":"int32","description":"It indicates the size of the array results.","example":25},"results":{"type":"array","items":{"$ref":"#/components/schemas/BusinessTripItem"}}}},"DateParam":{"description":"The end of the period of the search `toDate` included (i.e. less than) (Formats: `yyyy-MM-dd`, `yyyy-MM-ddThh:mm:ss`, `yyyy-MM-ddThh:mm:ssZ`).","example":"1970-01-30"},"SearchBusinessTripDateType":{"type":"string","description":"It determines the date to be considered for `fromDate` and `toDate` parameters.","enum":["CREATION_TIME","COMPLETED_TIME"],"example":"COMPLETED_TIME"},"Direction":{"type":"string","description":"It indicates how the pages are ordered.","enum":["ASC","DESC"],"example":"DESC"},"CardRuleCashPointRules":{"properties":{"daily":{"$ref":"#/components/schemas/CardRuleLimitPeriod","description":"It determines the possibility to withdraw at ATM up to a certain amount on a daily basis."},"weekly":{"$ref":"#/components/schemas/CardRuleLimitPeriod","description":"It determines the possibility to withdraw at ATM up to a certain amount on a weekly basis."},"monthly":{"$ref":"#/components/schemas/CardRuleLimitPeriod","description":"It determines the possibility to withdraw at ATM up to a certain amount on a monthly basis."},"chip_and_pin":{"$ref":"#/components/schemas/CardRuleChipAndPin","description":"It determines whether the `chipAndPin` is enabled."},"magstripe":{"$ref":"#/components/schemas/CardRuleMagstripe","description":"It determines whether the `magstripe` is enabled."}}},"CardRuleChipAndPin":{"properties":{"enabled":{"type":"boolean","description":"It determines whether the card rule is enabled.","example":true}}},"CardRuleLimitPeriod":{"properties":{"enabled":{"type":"boolean","description":"It determines whether the card rule is enabled.","example":true},"max":{"type":"number","description":"Maximum spendable amount related to the limit.","example":10.25},"spent":{"type":"number"},"left":{"type":"number"}}},"CardRuleMagstripe":{"properties":{"enabled":{"type":"boolean","description":"It determines whether the card rule is enabled.","example":true}}},"CardRuleCountries":{"properties":{"total":{"type":"integer","format":"int32","description":"It represents the total number of available items in the list.","example":168},"results":{"type":"array","items":{"$ref":"#/components/schemas/CardRuleCountry"}}}},"CardRuleCountry":{"properties":{"code":{"$ref":"#/components/schemas/ISO3166CardRuleCountryCode","description":"The code of the country [ISO 3166-1 alpha-3](https://www.iso.org/obp/ui/#search/code/) to be updated.","example":"GBR"},"enabled":{"type":"boolean","description":"It determines whether the card should be allowed to spend money in that country.","example":true}},"required":["code","enabled"]},"ISO3166CardRuleCountryCode":{"type":"string","enum":["ABW","AFG","AGO","AIA","ALB","AND","ARE","ARG","ARM","ASM","ATG","AUS","AUT","AZE","BDI","BEL","BEN","BES","BFA","BGD","BGR","BHR","BHS","BIH","BLM","BLR","BLZ","BMU","BOL","BRA","BRB","BRN","BTN","BWA","CAF","CAN","CCK","CHE","CHL","CHN","CIV","CMR","COD","COG","COK","COL","COM","CPV","CRI","CUB","CUW","CXR","CYM","CYP","CZE","DEU","DJI","DMA","DNK","DOM","DZA","ECU","EGY","ERI","ESP","EST","ETH","FIN","FJI","FLK","FRA","FRO","FSM","GAB","GBR","GEO","GGY","GHA","GIB","GIN","GMB","GNB","GNQ","GRC","GRD","GRL","GTM","GUM","GUY","HKG","HND","HRV","HTI","HUN","IDN","IMN","IND","IRL","IRN","IRQ","ISL","ISR","ITA","JAM","JEY","JOR","JPN","KAZ","KEN","KGZ","KHM","KIR","KNA","KOR","KWT","LAO","LBN","LBR","LBY","LCA","LIE","LKA","LSO","LTU","LUX","LVA","MAC","MAF","MAR","MCO","MDA","MDG","MDV","MEX","MHL","MKD","MLI","MLT","MMR","MNE","MNG","MNP","MOZ","MRT","MSR","MUS","MWI","MYS","NAM","NCL","NER","NFK","NGA","NIC","NIU","NLD","NOR","NPL","NRU","NZL","OMN","PAK","PAN","PCN","PER","PHL","PLW","PNG","POL","PRI","PRK","PRT","PRY","PSE","PYF","QAT","ROU","RUS","RWA","SAU","SDN","SEN","SGP","SHN","SLB","SLE","SLV","SMR","SOM","SPM","SRB","SSD","STP","SUR","SVK","SVN","SWE","SWZ","SXM","SYC","SYR","TCA","TCD","TGO","THA","TJK","TKL","TKM","TLS","TON","TTO","TUN","TUR","TUV","TWN","TZA","UGA","UKR","URY","USA","UZB","VAT","VCT","VEN","VGB","VIR","VNM","VUT","WLF","WSM","XXK","YEM","ZAF","ZMB","ZWE"]},"CardRuleMerchantCategories":{"properties":{"total":{"type":"integer","format":"int32","description":"It represents the total number of available items in the list.","example":168},"results":{"type":"array","items":{"$ref":"#/components/schemas/CardRuleMerchantCategory"}}}},"CardRuleMerchantCategory":{"properties":{"name":{"$ref":"#/components/schemas/MerchantCategory","description":"The `MerchantCategory`.","example":"Services_Business"},"enabled":{"type":"boolean","description":"It determines whether the rule is enabled.","example":true}},"required":["enabled","name"]},"CardRuleMaxPerTransaction":{"properties":{"enabled":{"type":"boolean","description":"It determines whether the card rule is enabled.","example":true},"max":{"type":"number","description":"Maximum spendable amount related to the limit.","example":10.25},"spent":{"type":"number"},"left":{"type":"number"}}},"CardRuleSpendingLimitsRules":{"properties":{"daily":{"$ref":"#/components/schemas/CardRuleLimitPeriod","description":"It determines the possibility to spend up to a certain amount on a daily basis."},"weekly":{"$ref":"#/components/schemas/CardRuleLimitPeriod","description":"It determines the possibility to spend up to a certain amount per transaction."},"monthly":{"$ref":"#/components/schemas/CardRuleLimitPeriod","description":"It determines the possibility to spend up to a certain amount on a monthly basis."},"per_transaction":{"$ref":"#/components/schemas/CardRuleMaxPerTransaction","description":"It determines the possibility to spend up to a certain amount on a weekly basis."}}},"Cards":{"properties":{"total":{"type":"integer","format":"int32","description":"It represents the total number of available items in the list.","example":168},"pages":{"type":"integer","format":"int32","description":"It represents the total number of available pages.","example":7},"page_size":{"type":"integer","format":"int32","description":"It represents the number of items per page.","example":25},"current_page":{"type":"integer","format":"int32","description":"It indicates the current page (the counter starts from zero).","example":0},"results_size":{"type":"integer","format":"int32","description":"It indicates the size of the array results.","example":25},"results":{"type":"array","items":{"$ref":"#/components/schemas/Card"}}}},"CardAttachedResourceType":{"type":"string","description":"The type of a resource the `Card` is attached to.","enum":["wallet","company","employee","onlineAd","subscription","purchase"],"example":"wallet"},"ExpenseReviewProcessPriorities":{"properties":{"new_priority":{"type":"number","default":"1","description":"The new order of priority in which the `ExpenseReviewProcess` will be executed.","example":2,"minimum":1},"process_id":{"type":"string","description":"The ID of the `ExpenseReviewProcess` for which the priority should be updated.","example":"135fdb6c-2e77-4fc0-a79f-2453fde75ef7"}},"required":["new_priority","process_id"]},"ExpenseReviewProcessPriority":{"description":"Change `ExpenseReviewProcess` priority JSON parameters.","properties":{"priorities":{"type":"array","description":"A list of `ExpenseReviewProcesses` for which the priority should be updated with their new priority.","items":{"$ref":"#/components/schemas/ExpenseReviewProcessPriorities"}}},"required":["priorities"]},"Company":{"properties":{"name":{"type":"string","description":"The name of the `Company`.","example":"Example Inc."},"icon_code":{"type":"string","deprecated":true,"description":"The iconCode of the `Company`."},"vat_number":{"type":"string","description":"The VAT number of the `Company`.","example":98746784967},"company_account_id":{"type":"string","description":"The `Company` ID requested at the login.","example":"XMPL1234"},"shipping_address":{"$ref":"#/components/schemas/Address","description":"The default shipping `Address` of the `Company`."},"time_zone":{"type":"string","description":"The time zone name of the country the `Company` Soldo account is registered to (based on tz database format).","example":"Europe/London"},"market":{"$ref":"#/components/schemas/ISO3166Country","description":"The [ISO 3166-1 alpha-3](https://www.iso.org/obp/ui/#search/code/) code of the country the `Company` Soldo account is registered in.","example":"GBR"},"financial_entity":{"$ref":"#/components/schemas/FinancialEntity","description":"The Soldo entity providing financial services to the ‘Company‘ (‘SFS-UK‘ stands for Soldo Financial Services Ltd. while ‘SFS-IRL‘ stands for Soldo Financial Services Ireland DAC).","example":"SFS-IRL"},"creation_time":{"type":"string","description":"The date and time when the `Company` was created.","example":"2017-06-01T12:48:40Z"},"last_update":{"type":"string","description":"The date and time when the `Company` was last updated.","example":"2017-06-01T12:48:40Z"}}},"FinancialEntity":{"type":"string","enum":["SFS-UK","SFS-IRL"]},"CompleteBusinessTripTransfer":{"description":"Complete `BusinessTrip` Transfer JSON parameters.","properties":{"request_timestamp":{"type":"integer","format":"int64","description":"The epoch timestamp in millis. This is checked in Soldo. Requests with timestamp older than 5 seconds will be rejected.","example":1576850500000}}},"Contacts":{"properties":{"total":{"type":"integer","format":"int32","description":"It represents the total number of available items in the list.","example":168},"pages":{"type":"integer","format":"int32","description":"It represents the total number of available pages.","example":7},"page_size":{"type":"integer","format":"int32","description":"It represents the number of items per page.","example":25},"current_page":{"type":"integer","format":"int32","description":"It indicates the current page (the counter starts from zero).","example":0},"results_size":{"type":"integer","format":"int32","description":"It indicates the size of the array results.","example":25},"results":{"type":"array","items":{"$ref":"#/components/schemas/Contact"}}}},"CreateUser":{"properties":{"request_timestamp":{"type":"integer","format":"int64","description":"The epoch timestamp in millis. This is checked in Soldo. Requests with timestamp older than 5 seconds will be rejected.","example":1576850500000},"name":{"type":"string","description":"The name of the `User`.","example":"John"},"middlename":{"type":"string","description":"The middle name of the `User`.","example":"John"},"surname":{"type":"string","description":"The surname of the `User`.","example":"Smith"},"job_title":{"type":"string","description":"The job title of the `User`.","example":"Business Strategist"},"email":{"type":"string","description":"The email address of the `User`.","example":"jdoe@fake.soldo.com"},"mobile":{"type":"string","description":"The mobile number of the `User`.","example":"+44123323232"},"mobile_prefix":{"type":"string","description":"The mobile number country prefix (e.g. +44).","example":"+44"},"mobile_access":{"type":"boolean","default":"false","description":"It determines whether the `User` has mobile access.","example":true},"web_access":{"type":"boolean","default":"false","description":"It determines whether the `User` has web access.","example":true},"custom_reference_id":{"type":"string","description":"The `User` reference in an external system.","example":"123456-user-1"},"reports_to":{"type":"string","description":"The ID of the `User` they report to.","example":"XMPL1234-000001"},"status":{"$ref":"#/components/schemas/UpdatableUserStatus","default":"ACTIVE","description":"The status of the `User` being created.","example":"ACTIVE"}},"required":["mobile","mobile_access","mobile_prefix","name","request_timestamp","surname","web_access"]},"UpdatableUserStatus":{"type":"string","enum":["ACTIVE","INACTIVE"]},"MileageReimbursementDetails":{"properties":{"vehicle_id":{"type":"string","description":"The ID of the `Vehicle` used, if registered.","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"},"reimbursement_rate":{"type":"number","description":"The rate to apply to the covered distance (measured in km) for the reimbursement, assuming the main `Wallet` currency.","example":0.45},"description":{"type":"string","description":"The description for the trip.","example":"Business trip: Rome - Florence - Turin - Milan"},"starting_point":{"type":"string","description":"The place where the travel started.","example":"Rome, Metropolitan City of Rome Capital, Italy"},"arrival_point":{"type":"string","description":"The point where the travel ended.","example":"Milan, Metropolitan City of Milan, Italy"},"multi_stops":{"type":"array","description":"The intermediate stops during the travel.","example":["Florence, Metropolitan City of Florence, Italy","Turin, Metropolitan City of Turin, Italy"],"items":{"type":"string"}},"distance":{"type":"number","description":"The travelled distance from the starting point to the arrival point (measured in km).","example":875.4},"round_trip":{"type":"boolean","description":"Whether the distance has been travelled twice due to a round trip.","example":true}}},"MileageReimbursementTransaction":{"properties":{"transaction_id":{"type":"string","description":"The ID of the `Transaction` describing the `MileageReimbursement`.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"date":{"type":"string","description":"The date and time of the `Transaction`.","example":"2017-06-01T12:48:40Z"},"owner_id":{"type":"string","description":"The ID of the `User` who made the `Transaction` (updatable: no).","example":"XMPL1234-000002"},"amount":{"type":"number","description":"The amount of the `Transaction`, in the currency of the main `Wallet`.","example":10.25},"amount_currency":{"$ref":"#/components/schemas/ISO4217Currency","description":"The currency [ISO 4217](https://www.six-group.com/en/products-services/financial-information/data-standards.html#scrollTo=maintenance-agency) code of the `amount`.","example":"EUR"},"mileage":{"$ref":"#/components/schemas/MileageReimbursementDetails","description":"The details of the `MileageReimbursement`."}}},"CreateMileageReimbursementTransaction":{"description":"Create `MileageReimbursement` `Transaction` JSON parameters.","properties":{"request_timestamp":{"type":"integer","format":"int64","description":"The epoch timestamp in millis. This is checked in Soldo. Requests with timestamp older than 5 seconds will be rejected.","example":1576850500000},"date":{"type":"string","description":"The date and time of the `Transaction`.","example":"2017-06-01T12:48:40Z"},"owner_id":{"type":"string","description":"The ID of the `User` who made the `Transaction` (updatable: no).","example":"XMPL1234-000002"},"mileage":{"$ref":"#/components/schemas/MileageReimbursementDetailsCreateRequest","description":"The details of the `MileageReimbursement`."}},"required":["date","mileage","owner_id","request_timestamp"]},"MileageReimbursementDetailsCreateRequest":{"properties":{"vehicle_id":{"type":"string","description":"The ID of the `Vehicle` used, if registered.","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"},"reimbursement_rate":{"type":"number","description":"The rate to apply to the covered distance (measured in km) for the reimbursement, assuming the main `Wallet` currency. Required if `vehicle_id` is missing or if no reimbursement rate is set for the related `Vehicle`. Overridden if `vehicle_id` is set and a reimbursement rate is set for the related `Vehicle`.","example":0.45},"description":{"type":"string","description":"The description for the trip.","example":"Business trip: Rome - Florence - Turin - Milan"},"starting_point":{"type":"string","description":"The place where the travel started.","example":"Rome, Metropolitan City of Rome Capital, Italy"},"arrival_point":{"type":"string","description":"The point where the travel ended.","example":"Milan, Metropolitan City of Milan, Italy"},"multi_stops":{"type":"array","description":"The intermediate stops during the travel.","example":["Florence, Metropolitan City of Florence, Italy","Turin, Metropolitan City of Turin, Italy"],"items":{"type":"string"}},"distance":{"type":"number","description":"The travelled distance from the starting point to the arrival point (measured in km).","example":875.4},"round_trip":{"type":"boolean","description":"Whether the distance has been travelled twice due to a round trip.","example":true}},"required":["description","distance","round_trip"]},"OnlineAdsList":{"properties":{"total":{"type":"integer","format":"int32","description":"It represents the total number of available items in the list.","example":168},"pages":{"type":"integer","format":"int32","description":"It represents the total number of available pages.","example":7},"page_size":{"type":"integer","format":"int32","description":"It represents the number of items per page.","example":25},"current_page":{"type":"integer","format":"int32","description":"It indicates the current page (the counter starts from zero).","example":0},"results_size":{"type":"integer","format":"int32","description":"It indicates the size of the array results.","example":25},"results":{"type":"array","items":{"$ref":"#/components/schemas/OnlineAds"}}}},"CreateOnlineAds":{"description":"Add `OnlineAd` JSON parameters.","properties":{"name":{"type":"string","description":"The name of the `OnlineAds`.","example":"Google Ads"},"description":{"type":"string","description":"The description of the `OnlineAds`.","example":"Google Ads Campaign"},"platform":{"$ref":"#/components/schemas/OnlineAdsPlatform","description":"The platform of the `OnlineAds`.","example":"GOOGLE"},"assignees":{"type":"array","description":"List of `User` IDs to be assigned to the `OnlineAds` and its `Cards`.","example":["XMPL1234-000001","XMPL1234-000002","XMPL1234-000003"],"items":{"type":"string"},"uniqueItems":true},"wallet_id":{"type":"string","description":"The `Wallet` ID associated to the `OnlineAds`.","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"}},"required":["assignees","description","name","platform","wallet_id"]},"OutOfPlatformTransaction":{"properties":{"transaction_id":{"type":"string","description":"The ID of the Out-Of-Platform `Transaction`.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"date":{"type":"string","description":"The date and time of the `Transaction`.","example":"2017-06-01T12:48:40Z"},"owner_id":{"type":"string","description":"The ID of the `User` who made the `Transaction` (updatable: no).","example":"XMPL1234-000002"},"merchant_name":{"type":"string","description":"The name of the `Merchant` for the `Transaction`.","example":"SHH HOTEL LONDON"},"tx_amount":{"type":"number","description":"The amount of the `Transaction`, in the currency of the `Merchant`.","example":10.25},"tx_amount_currency":{"$ref":"#/components/schemas/ISO4217Currency","description":"The currency [ISO 4217](https://www.six-group.com/en/products-services/financial-information/data-standards.html#scrollTo=maintenance-agency) code of the `tx_amount`.","example":"EUR"},"amount":{"type":"number","description":"The amount of the `Transaction`, in the currency of the main `Wallet`.","example":10.25},"amount_currency":{"$ref":"#/components/schemas/ISO4217Currency","description":"The currency [ISO 4217](https://www.six-group.com/en/products-services/financial-information/data-standards.html#scrollTo=maintenance-agency) code of the `amount`.","example":"EUR"},"exchange_rate":{"type":"number","description":"The exchange rate used to convert the `tx_amount` from the currency of the `Merchant` to the currency of the main `Wallet`.","example":1},"payment_method":{"$ref":"#/components/schemas/OutOfPlatformTransactionPaymentMethod","description":"The payment method of the `Transaction`.","example":"OUT_OF_PLATFORM_PERSONAL"}}},"OutOfPlatformTransactionPaymentMethod":{"type":"string","enum":["OUT_OF_PLATFORM_COMPANY","OUT_OF_PLATFORM_PERSONAL"]},"CreateOutOfPlatformTransaction":{"description":"Create Out-Of-Platform `Transaction` JSON parameters.","properties":{"request_timestamp":{"type":"integer","format":"int64","description":"The epoch timestamp in millis. This is checked in Soldo. Requests with timestamp older than 5 seconds will be rejected.","example":1576850500000},"date":{"type":"string","description":"The date and time of the `Transaction`.","example":"2017-06-01T12:48:40Z"},"owner_id":{"type":"string","description":"The ID of the `User` who made the `Transaction` (updatable: no).","example":"XMPL1234-000002"},"merchant_name":{"type":"string","description":"The name of the `Merchant` for the `Transaction`.","example":"SHH HOTEL LONDON"},"tx_amount":{"type":"number","description":"The amount of the `Transaction`, in the currency of the `Merchant`.","example":10.25},"tx_amount_currency":{"$ref":"#/components/schemas/ISO4217Currency","description":"The currency [ISO 4217](https://www.six-group.com/en/products-services/financial-information/data-standards.html#scrollTo=maintenance-agency) code of the `tx_amount`.","example":"EUR"},"exchange_rate":{"type":"number","description":"The exchange rate used to convert the `tx_amount` from the currency of the `Merchant` to the currency of the main `Wallet`. If needed and not provided, a default rate is derived from `date`.","example":1},"payment_method":{"$ref":"#/components/schemas/OutOfPlatformTransactionPaymentMethod","description":"The payment method of the `Transaction`.","example":"OUT_OF_PLATFORM_PERSONAL"}},"required":["date","merchant_name","owner_id","payment_method","request_timestamp","tx_amount","tx_amount_currency"]},"CreateSubscription":{"description":"Add `Subscription` JSON parameters.","properties":{"name":{"type":"string","description":"The name of the `Subscription`.","example":"Google Ads"},"description":{"type":"string","description":"The description of the `Subscription`.","example":"This is a resource set"},"platform":{"$ref":"#/components/schemas/SubscriptionPlatform","description":"The platform of the `Subscription`.","example":"GOOGLE"},"assignees":{"type":"array","description":"The assignees of the `Subscription`.","example":["XMPL1234-000001","XMPL1234-000002","XMPL1234-000003"],"items":{"type":"string"}},"wallet_id":{"type":"string","description":"The ID of the associated `Wallet`.","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"},"payment_frequency":{"$ref":"#/components/schemas/SubscriptionPaymentFrequency","description":"The payment frequency indicates how often a `Transaction` is expected to be made.","example":"YEARLY"}},"required":["assignees","description","name","payment_frequency","platform","wallet_id"]},"CreateTransactionSplit":{"description":"Create `Transaction` split JSON parameters.","properties":{"split_transactions":{"type":"array","items":{"$ref":"#/components/schemas/SplitTransaction"},"minItems":2}},"required":["split_transactions"]},"SplitTag":{"properties":{"tag_id":{"type":"string","description":"The `Tags` of the `SplitTransaction`.","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"},"dictionary_id":{"type":"string","description":"The `dictionaryId` of the `Tag` of the `SplitTransaction`.","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"}}},"SplitTransaction":{"properties":{"amount":{"type":"number","description":"The amount of the `SplitTransaction` line.","example":10.25},"expense_type":{"$ref":"#/components/schemas/ExpenseType","description":"The type of the expense of the `SplitTransaction` line.","example":"TRAVEL_AND_ENTERTAINMENT"},"user_id":{"type":"string","description":"The ID of the `User` assigned to the `SplitTransaction` line.","example":"XMPL1234-000003"},"expense_category_id":{"type":"string","description":"The expense category of the `SplitTransaction` line.","example":"e0d9b9c2-4a13-4ad5-85a4-88882fa065bd"},"tax_rate_id":{"type":"string","description":"The ID of VAT Rate of the `SplitTransaction` line.","example":"c861cc24-6663-410f-8c78-73f886fff4ef"},"tags":{"type":"array","description":"The IDs of the `Tag` and related `Dictionary` to be assigned to a `SplitTransaction` line.","items":{"$ref":"#/components/schemas/SplitTag"}}},"required":["amount"]},"CreateWallet":{"properties":{"request_timestamp":{"type":"integer","format":"int64","description":"The epoch timestamp in millis. This is checked in Soldo. Requests with timestamp older than 5 seconds will be rejected.","example":1576850500000},"name":{"type":"string","description":"The name of the `Wallet`.","example":"John Doe"},"description":{"type":"string","description":"The description of the `Wallet`.","example":"My company wallet"},"currency":{"$ref":"#/components/schemas/ISO4217SupportedCurrency","description":"The [ISO 4217](https://www.six-group.com/en/products-services/financial-information/data-standards.html#scrollTo=maintenance-agency) code of the currency of the `Wallet`.","example":"EUR"},"owner_type":{"$ref":"#/components/schemas/AddWalletOwnerType","description":"The type of the owner of the `Wallet`.","example":"company"}},"required":["currency","name","request_timestamp"]},"DeclineRequest":{"properties":{"supervisor_note":{"type":"string","description":"The supervisor's note of the `Request` (sortable: no).","example":"Requester note"},"reviewer":{"type":"string","description":"The reviewer's note of the `Request` (sortable: no).","example":"XMPL1234-000001"}},"required":["reviewer","supervisor_note"]},"CardRuleCashPointRule":{"properties":{"enabled":{"type":"boolean","description":"It determines whether the card rule is enabled.","example":true},"amount":{"type":"number","description":"Amount of the limit.","example":10.25}}},"CardRuleCashPointLimitName":{"type":"string","description":"A `CardRuleCashPointRule` limit name.","enum":["daily","weekly","monthly","chipAndPin","magstripe"]},"CardRuleSpendingLimitsRule":{"properties":{"enabled":{"type":"boolean","description":"It determines whether the card rule is enabled.","example":true},"amount":{"type":"number","description":"Amount of the limit.","example":10.25}}},"CardRuleSpendingLimitsLimitName":{"type":"string","description":"A SpendingLimit rule name.","enum":["daily","weekly","monthly","perTransaction"]},"UpdateCardRuleCashPoint":{"description":"`CardRuleCashPointRule` parameters.","properties":{"enabled":{"type":"boolean","description":"It determines whether the card rule is enabled.","example":true},"max":{"type":"number","format":"double","description":"Maximum spendable amount related to the limit.","example":10.25}},"required":["enabled","max"]},"UpdateCardRuleCountries":{"description":"`CardRuleCountries` parameters.","properties":{"request_timestamp":{"type":"integer","format":"int64","description":"The epoch timestamp in millis. This is checked in Soldo. Requests with timestamp older than 5 seconds will be rejected.","example":1576850500000},"countries":{"type":"array","description":"A list of [ISO 3166-1 alpha-3](https://www.iso.org/obp/ui/#search/code/) country code and `enabled` pairs.","items":{"$ref":"#/components/schemas/CardRuleCountry"}}},"required":["countries","request_timestamp"]},"UpdateCardRuleMerchantCategories":{"description":"`CardRuleMerchantCategories` parameters.","properties":{"request_timestamp":{"type":"integer","format":"int64","description":"The epoch timestamp in millis. This is checked in Soldo. Requests with timestamp older than 5 seconds will be rejected.","example":1576850500000},"merchant_categories":{"type":"array","description":"A list of `MerchantCategory` and `enabled` pairs.","items":{"$ref":"#/components/schemas/CardRuleMerchantCategory"}}},"required":["merchant_categories","request_timestamp"]},"UpdateCardRuleSpendingLimit":{"description":"SpendingLimit rule parameters.","properties":{"enabled":{"type":"boolean","description":"It determines whether the card rule is enabled.","example":true},"max":{"type":"number","format":"double","description":"Maximum spendable amount related to the limit.","example":10.25}},"required":["enabled","max"]},"UserItem":{"properties":{"id":{"type":"string","description":"The `User` ID.","example":"XMPL1234-000001"},"name":{"type":"string","description":"The name of the `User` (sortable: yes).","example":"John"},"surname":{"type":"string","description":"The surname of the `User` (sortable: yes).","example":"Smith"},"middlename":{"type":"string","description":"The middlename of the `User` (sortable: no).","example":"John"},"dob":{"type":"string","description":"The Date of birth of the `User`.","example":"1970-10-21"},"job_title":{"type":"string","description":"The job title of the `User` (sortable: yes).","example":"Business Strategist"},"department":{"type":"string","description":"The department of the `User` (sortable: no).","example":"Research & Development"},"email":{"type":"string","description":"The email address of the `User` (sortable: no).","example":"jdoe@fake.soldo.com"},"mobile":{"type":"string","description":"The mobile number of the `User` including the country code (sortable: no).","example":"+44123323232"},"custom_reference_id":{"type":"string","description":"The reference of the employee in an external system (sortable: yes).","example":"123456-user-1"},"status":{"$ref":"#/components/schemas/UserStatus","description":"The status of the `User` (sortable: yes).","example":"ACTIVE"},"visible":{"type":"boolean","description":"It determines whether the `User` is visible in the web console (sortable: yes).","example":true},"groups":{"type":"array","description":"The list of `Groups` ID the `User` is member of (sortable: no).","example":["7bf79328-a7ae-4222-aa54-091ff7f429a7","2d65bd5e-3fdf-4002-b166-bde7fb8863fa"],"items":{"type":"string"}},"reports_to":{"type":"string","description":"The ID of the `User` it reports to.","example":"XMPL1234-000001"},"roles":{"type":"array","description":"The list of `UserRole` of the `User`.","items":{"$ref":"#/components/schemas/UserRole"}},"contact_id":{"type":"string","description":"The ID of the `Contact` assigned to the `User`. This information can be updated from the [Add Contact](ref:contact-add) and [Update Contact](ref:contact-update) endpoints.","example":"135fdb6c-2e77-4fc0-a79f-2453fde75ef7"},"creation_time":{"type":"string","description":"The date and time when the `User` was created (sortable: yes).","example":"2017-06-01T12:48:40Z"},"last_update":{"type":"string","description":"The date and time when the `User` was last updated (sortable: yes).","example":"2017-06-01T12:48:40Z"},"work_status":{"$ref":"#/components/schemas/WorkStatus","description":"The work status of the `User`.","example":"OUT_OF_OFFICE"}}},"Users":{"properties":{"total":{"type":"integer","format":"int32","description":"It represents the total number of available items in the list.","example":168},"pages":{"type":"integer","format":"int32","description":"It represents the total number of available pages.","example":7},"page_size":{"type":"integer","format":"int32","description":"It represents the number of items per page.","example":25},"current_page":{"type":"integer","format":"int32","description":"It indicates the current page (the counter starts from zero).","example":0},"results_size":{"type":"integer","format":"int32","description":"It indicates the size of the array results.","example":25},"results":{"type":"array","items":{"$ref":"#/components/schemas/UserItem"}}}},"ExpenseCategories":{"properties":{"total":{"type":"integer","format":"int32","description":"It represents the total number of available items in the list.","example":168},"pages":{"type":"integer","format":"int32","description":"It represents the total number of available pages.","example":7},"page_size":{"type":"integer","format":"int32","description":"It represents the number of items per page.","example":25},"current_page":{"type":"integer","format":"int32","description":"It indicates the current page (the counter starts from zero).","example":0},"results_size":{"type":"integer","format":"int32","description":"It indicates the size of the array results.","example":25},"results":{"type":"array","items":{"$ref":"#/components/schemas/ExpenseCategory"}}}},"ExpenseReport":{"properties":{"reimburse_amount":{"type":"number","description":"The amount to be reimbursed to the user."},"deduct_amount":{"type":"number","description":"The amount to be deducted from the user."},"process_amount":{"type":"number","description":"The amount to be processed."},"file_url":{"type":"string","description":"The Base64 string of the File URL encrypted by DES in ECB mode, Pkcs7 padding scheme and using Token for key."},"id":{"type":"string","description":"The  `ExpenseReport` ID .","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"protocol":{"type":"string","description":"The  `ExpenseReport` ID protocol."},"number":{"type":"string","description":"The  `ExpenseReport` number."},"type":{"$ref":"#/components/schemas/ExpenseReportType","description":"The type of the  `ExpenseReport`."},"status":{"$ref":"#/components/schemas/ExpenseReportStatusOutput","description":"The status of the  `ExpenseReport`."},"exported_date":{"type":"string","description":"The date when the  `ExpenseReport` got exported."},"exported_by":{"type":"string","description":"The ID of the user who exported the  `ExpenseReport`."},"trx_owner_id":{"type":"string","description":"The  ID of the user who made the expenses included in the  `ExpenseReport`."},"trx_date_from":{"type":"string","description":"The date of the oldest expense included in the  `ExpenseReport`."},"trx_date_to":{"type":"string","description":"The date of the most recent expense included in the  `ExpenseReport`."},"processed_date":{"type":"string","description":"The date when the expense report got processed."},"processed_by":{"type":"string","description":"The ID of the user who processed the  `ExpenseReport`."},"reimbursement_transaction_id":{"type":"string","description":"The ID of the transaction of the `ExpenseReport`."}}},"ExpenseReportStatusOutput":{"type":"string","enum":["PROCESSED","CANCELLED","DELETED","TO_BE_PROCESSED"]},"ExpenseReportType":{"type":"string","enum":["EMPLOYEE","COMPANY"]},"ExpenseReportDownload":{"properties":{"file_url":{"type":"string","description":"The  `ExpenseReport`file URL "}}},"ExpenseReportFileType":{"type":"string","description":"The `ExpenseReport` file type.","enum":["PDF","PDF_WITH_ATTACHMENTS"],"example":"PDF"},"ExpenseItem":{"properties":{"user_id":{"type":"string","description":"The ID of the `User` (sortable: no).","example":"XMPL1234-000001"},"user_name":{"type":"string","description":"The name of the `User` (sortable: yes).","example":"JOHN"},"user_surname":{"type":"string","description":"The surname of the `User` (sortable: yes).","example":"DOE"},"job_title":{"type":"string","description":"The job title of the `User` (sortable: yes).","example":"CTO"},"to_review_transaction":{"type":"integer","format":"int64","description":"The number of the `Transaction` items in status `TO_REVIEW` (sortable: no).","example":1},"reviewed_transaction":{"type":"integer","format":"int64","description":"The number of the `Transaction` items in status `REVIEWED` (sortable: no).","example":2},"exported_transaction":{"type":"integer","format":"int64","description":"The number of the `Transaction` items in status `EXPORTED` (sortable: no).","example":1},"total_transaction":{"type":"integer","format":"int64","description":"The number of `Transaction` items (sortable: no).","example":3},"from_date":{"type":"string","description":"The beginning of the period of the search (sortable: no).","example":"2017-06-01T12:48:40Z"},"to_date":{"type":"string","description":"The end of the period of the search (sortable: no).","example":"2017-06-05T12:48:40Z"},"transaction_to_review":{"type":"array","description":"The array contains ID of the `Transaction` in status `TO_REVIEW` (sortable: no).","example":["7bf79328-a7ae-4222-aa54-091ff7f429a7","2d65bd5e-3fdf-4002-b166-bde7fb8863fa"],"items":{"type":"string"}},"transaction_reviewed":{"type":"array","description":"The array contains ID of the `Transaction` in status `REVIEWED` (sortable: no).","example":["7bf79328-a7ae-4222-aa54-091ff7f429a7","2d65bd5e-3fdf-4002-b166-bde7fb8863fa"],"items":{"type":"string"}},"transaction_exported":{"type":"array","description":"The array array contains ID of the `Transaction` in status `EXPORTED` (sortable: no).","example":["7bf79328-a7ae-4222-aa54-091ff7f429a7","2d65bd5e-3fdf-4002-b166-bde7fb8863fa"],"items":{"type":"string"}}}},"ExpensePaymentMethod":{"type":"string","description":"It determines the filter by payment method of the transaction.","enum":["USER","COMPANY","PURCHASE","SUBSCRIPTION","ONLINE_ADS","OUT_OF_PLATFORM_COMPANY","OUT_OF_PLATFORM_PERSONAL"]},"ExpenseReviewProcessItems":{"properties":{"id":{"type":"string","description":"The `ExpenseReviewProcess` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"name":{"type":"string","description":"The name of the `ExpenseReviewProcess` (sortable: yes).","example":"EXPENSE REVIEW PROCESS"},"description":{"type":"string","description":"A textual description of the `ExpenseReviewProcess`.","example":"EXPENSE REVIEW PROCESS DESCRIPTION"},"steps_count":{"type":"integer","format":"int32","description":"The total number of approval steps.","example":2},"priority":{"type":"integer","format":"int32","description":"The order of priority in which the `ExpenseReviewProcess` will be executed (sortable: yes).","example":2},"status":{"$ref":"#/components/schemas/ExpenseReviewProcessStatus","description":"The status of the `ExpenseReviewProcess` (sortable: yes).","example":"ACTIVE"}}},"ExpenseReviewProcesses":{"properties":{"total":{"type":"integer","format":"int32","description":"It represents the total number of available items in the list.","example":168},"pages":{"type":"integer","format":"int32","description":"It represents the total number of available pages.","example":7},"page_size":{"type":"integer","format":"int32","description":"It represents the number of items per page.","example":25},"current_page":{"type":"integer","format":"int32","description":"It indicates the current page (the counter starts from zero).","example":0},"results_size":{"type":"integer","format":"int32","description":"It indicates the size of the array results.","example":25},"results":{"type":"array","items":{"$ref":"#/components/schemas/ExpenseReviewProcessItems"}}}},"ExpenseReviewProcessStatusSearch":{"type":"string","description":"The status of the `ExpenseReviewProcess`.","enum":["ACTIVE","INACTIVE"]},"SendExpensesReminder":{"description":"Send Expense reminder JSON parameters.","properties":{"request_timestamp":{"type":"integer","format":"int64","description":"The epoch timestamp in millis. This is checked in Soldo. Requests with timestamp older than 5 seconds will be rejected.","example":1576850500000},"from_date":{"$ref":"#/components/schemas/DateParam","description":"The beginning of the period of the search `fromDate` included (i.e. greater than or equal to) (Formats: `yyyy-MM-dd`, `yyyy-MM-ddThh:mm:ss`, `yyyy-MM-ddThh:mm:ssZ`).","example":"2020-04-06T12:48:40Z"},"to_date":{"$ref":"#/components/schemas/DateParam","description":"The end of the period of the search `toDate` included (i.e. less than) (Formats: `yyyy-MM-dd`, `yyyy-MM-ddThh:mm:ss`, `yyyy-MM-ddThh:mm:ssZ`).","example":"2020-05-07T12:48:40Z"}},"required":["from_date","request_timestamp","to_date"]},"ExportExpenseReview":{"properties":{"expense_report_protocol_ids":{"type":"array","description":"The protocol IDs of the `ExpenseReport`.","example":["7bf79328-a7ae-4222-aa54-091ff7f429a7","2d65bd5e-3fdf-4002-b166-bde7fb8863fa"],"items":{"type":"string"}}}},"ExportExpense":{"description":"Export the Expenses JSON parameters.","properties":{"transaction_ids":{"type":"array","description":"An array of `Transaction` ID to be exported","example":["7bf79328-a7ae-4222-aa54-091ff7f429a7","2d65bd5e-3fdf-4002-b166-bde7fb8863fa"],"items":{"type":"string"}},"exported_by_id":{"type":"string","description":"The ID of the `User` who exports the expense.","example":"XMPL1234-000003"}},"required":["transaction_ids"]},"CardRulePreset":{"properties":{"id":{"type":"string","description":"The `CardRulePreset` ID (sortable: no).","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"name":{"type":"string","description":"The name of `CardRulePreset` (sortable: no).","example":"DefaultPreset"},"description":{"type":"string","description":"The description of `CardRulePreset` (sortable: no).","example":"Default CardRule preset policy"},"creation_time":{"type":"string","description":"The date and time when the `CardRulePreset` was created.","example":"2017-06-01T12:48:40Z"},"last_update_time":{"type":"string","description":"The date and time when the `CardRulePreset` was last updated.","example":"2017-06-01T12:48:40Z"}}},"CardRuleItem":{"properties":{"name":{"$ref":"#/components/schemas/CardRuleName","description":"The name of the `CardRule` to update. To follow the implications of each rule when enabled (`enabled=true`) on a card:\n- `OpenCloseMasterLock`, card is locked and only admins can unlock it\n- `OpenClose`, card is locked and any user who have access to the card can unlock it\n- `OpenCloseAfterOneTx`, card is automatically locked after each transaction\n- `Online`, card can spend online\n- `Contactless`, card can spend contactless","example":"CashPoint"},"enabled":{"type":"boolean","description":"It determines whether the `CardRule` is enabled.","example":true}},"required":["enabled","name"]},"CardRuleList":{"properties":{"rules":{"type":"array","items":{"$ref":"#/components/schemas/CardRuleItem"}}}},"CardRuleName":{"type":"string","enum":["OpenCloseMasterLock","OpenClose","OpenCloseAfterOneTx","Online","Contactless"]},"TransactionMetadata":{"properties":{"id":{"type":"string","description":"The ID related to the custom generated Metadata of the `Transaction`."},"metadata":{"type":"object","additionalProperties":{},"description":"A generic JSON."},"creation_time":{"type":"string","description":"The date and time when the metadata was created (sortable: yes).","example":"2017-06-01T12:48:40Z"},"last_update":{"type":"string","description":"The date and time when the metadata was last updated (sortable: yes).","example":"2017-06-01T12:48:40Z"}}},"TransactionMetadataList":{"properties":{"total":{"type":"integer","format":"int32","description":"It represents the total number of available items in the list.","example":168},"pages":{"type":"integer","format":"int32","description":"It represents the total number of available pages.","example":7},"page_size":{"type":"integer","format":"int32","description":"It represents the number of items per page.","example":25},"current_page":{"type":"integer","format":"int32","description":"It indicates the current page (the counter starts from zero).","example":0},"results_size":{"type":"integer","format":"int32","description":"It indicates the size of the array results.","example":25},"results":{"type":"array","items":{"$ref":"#/components/schemas/TransactionMetadata"}}}},"WalletAutotransferPreset":{"properties":{"id":{"type":"string","description":"The unique identifier of the `AutoTransferPreset`. (Sortable: No).","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"name":{"type":"string","description":"The name of the `AutoTransferPreset`. (Sortable: No).","example":"DefaultPreset"},"description":{"type":"string","description":"The description of the `AutoTransferPreset`. (Sortable: No).","example":"Default CardRule preset policy"},"type":{"$ref":"#/components/schemas/WalletPresetType","description":"The type of `AutoTransferPreset`.","example":"PERIODIC"},"currency":{"type":"string","description":"The currency used in the `AutoTransferPreset`.","example":"EUR"},"number_of_assigned_wallets":{"type":"integer","format":"int32","description":"The number of wallets assigned to the `AutoTransferPreset`.","example":2},"wallet_from":{"type":"string","description":"The from wallet used for the `AutoTransferPreset`.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"wallet_to":{"type":"array","description":"The to wallet used for the `AutoTransferPreset`.","example":["7bf79328-a7ae-4222-aa54-091ff7f429a7","2d65bd5e-3fdf-4002-b166-bde7fb8863fa"],"items":{"type":"string"}},"creation_time":{"type":"string","description":"The date and time the `AutoTransferPreset` was created.","example":"2017-06-01T12:48:40Z"},"last_update_time":{"type":"string","description":"The date and time the `AutoTransferPreset` was last updated.","example":"2017-06-01T12:48:40Z"}}},"WalletPresetType":{"type":"string","description":"The type of `AutoTransferPreset`.","enum":["PERIODIC","LOW_BALANCE"]},"Groups":{"properties":{"total":{"type":"integer","format":"int32","description":"It represents the total number of available items in the list.","example":168},"pages":{"type":"integer","format":"int32","description":"It represents the total number of available pages.","example":7},"page_size":{"type":"integer","format":"int32","description":"It represents the number of items per page.","example":25},"current_page":{"type":"integer","format":"int32","description":"It indicates the current page (the counter starts from zero).","example":0},"results_size":{"type":"integer","format":"int32","description":"It indicates the size of the array results.","example":25},"results":{"type":"array","items":{"$ref":"#/components/schemas/Group"}}}},"TransferResult":{"properties":{"amount":{"type":"number","description":"The transferred amount.","example":10.25},"currency":{"$ref":"#/components/schemas/ISO4217Currency","description":"The currency of the transferred amount.","example":"EUR"},"datetime":{"type":"string","description":"The date and time of the transaction.","example":"2017-06-01T12:48:40Z"},"from_wallet":{"$ref":"#/components/schemas/Wallet","description":"The source wallet used for the transfer."},"to_wallet":{"$ref":"#/components/schemas/Wallet","description":"The destination wallet used for the transfer."}}},"Orders":{"properties":{"total":{"type":"integer","format":"int32","description":"It represents the total number of available items in the list.","example":168},"pages":{"type":"integer","format":"int32","description":"It represents the total number of available pages.","example":7},"page_size":{"type":"integer","format":"int32","description":"It represents the number of items per page.","example":25},"current_page":{"type":"integer","format":"int32","description":"It indicates the current page (the counter starts from zero).","example":0},"results_size":{"type":"integer","format":"int32","description":"It indicates the size of the array results.","example":25},"results":{"type":"array","items":{"$ref":"#/components/schemas/Order"}}}},"Purchases":{"properties":{"total":{"type":"integer","format":"int32","description":"It represents the total number of available items in the list.","example":168},"pages":{"type":"integer","format":"int32","description":"It represents the total number of available pages.","example":7},"page_size":{"type":"integer","format":"int32","description":"It represents the number of items per page.","example":25},"current_page":{"type":"integer","format":"int32","description":"It indicates the current page (the counter starts from zero).","example":0},"results_size":{"type":"integer","format":"int32","description":"It indicates the size of the array results.","example":25},"results":{"type":"array","items":{"$ref":"#/components/schemas/Purchase"}}}},"SearchPurchaseDateType":{"type":"string","description":"It determines the date to be considered for `fromDate` and `toDate` parameters.","enum":["CREATION_TIME","COMPLETED_TIME"],"example":"COMPLETED_TIME"},"RecalculateExpenseReviewProcess":{"description":"Recalculate `ExpenseReviewProcess` JSON parameters.","properties":{"transaction_ids":{"type":"array","description":"A list of transaction IDs for which the `ExpenseReviewProcess` they’re included into should be recalculated.","example":["7bf79328-a7ae-4222-aa54-091ff7f429a7","2d65bd5e-3fdf-4002-b166-bde7fb8863fa"],"items":{"type":"string"}}},"required":["transaction_ids"]},"Refueling":{"properties":{"public_id":{"type":"string","description":"The refueling ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"transaction_id":{"type":"string","description":"The `Transaction` ID (sortable: yes).","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"card_id":{"type":"string","description":"The ID of the `Card` used for the `Transaction` (sortable: no).","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"tx_status":{"$ref":"#/components/schemas/TransactionStatus","description":"The status of the refueling `Transaction` (sortable: yes)."},"transaction_sign":{"$ref":"#/components/schemas/TransactionSign","description":"The sign of the refueling `Transaction` amount (sortable: no).","example":"Negative"},"tx_amount":{"type":"number","description":"The amount of the refueling `Transaction` in the currency of the merchant (sortable: no).","example":10.25},"tx_amount_currency":{"$ref":"#/components/schemas/ISO4217Currency","description":"The currency [ISO 4217](https://www.six-group.com/en/products-services/financial-information/data-standards.html#scrollTo=maintenance-agency) code of the `tx_amount` (sortable: no).","example":"EUR"},"tx_date":{"type":"string","description":"The date and time of the transaction at the `Authorised` status (sortable: yes).","example":"2017-06-01T12:48:40Z"},"tx_settlement_date":{"type":"string","description":"The date and time of the transaction at the `Settled` status (sortable: yes).","example":"2017-06-01T12:48:40Z"},"update_time":{"type":"string","description":"The date and time of the last update to the refueling `Transaction` (sortable: yes).","example":"2017-06-01T12:48:40Z"},"tx_vat_amount":{"type":"number","description":"The amount of the VAT in the currency of the `Wallet` (sortable: no).","example":10.25},"tx_vat_currency":{"$ref":"#/components/schemas/ISO4217Currency","description":"The currency [ISO 4217](https://www.six-group.com/en/products-services/financial-information/data-standards.html#scrollTo=maintenance-agency) code of the `vat_amount` (sortable: no).","example":"EUR"},"tx_country":{"$ref":"#/components/schemas/ISO3166Country","description":"The [ISO 3166-1 alpha-3](https://www.iso.org/obp/ui/#search/code/) code of the country where the refueling `Transaction` was made  (sortable: no).","example":"GBR"},"plate":{"type":"string","description":"Vehicle's plate number.","example":"AA000BB"},"vehicle_fuel_type":{"$ref":"#/components/schemas/FuelType","description":"Fuel type specified in the Vehicle's configuration page.","example":"PETROL"},"vat_deductibility_percentage":{"type":"string","description":"The deductible VAT percentage configured for the vehicle.","example":"40%"},"mileage":{"type":"integer","format":"int32","description":"The vehicle mileage.","example":125000},"quantity":{"type":"number","description":"The fuel quantity as specified in the invoice.","example":80},"unit_price":{"type":"number","description":"The fuel unit price as specified on the transaction.","example":1.41},"tx_fuel_type":{"$ref":"#/components/schemas/FuelType","description":"The fuel type as specified on the transaction.","example":"PETROL"},"to_be_ignored":{"type":"boolean","description":"If the transaction link status is set to ignored.","example":true},"invoice_id":{"type":"integer","format":"int64","description":"Invoice ID.","example":4421109},"invoice_number":{"type":"string","description":"Invoice number.","example":"NVC112200987"},"invoice_date":{"type":"string","description":"Invoice date.","example":"2017-06-01T12:48:40Z"},"invoice_total_amount":{"type":"number","description":"Total amount of the linked invoice.","example":10.25},"invoice_row":{"type":"integer","format":"int32","description":"Row of the linked invoice.","example":4},"invoice_row_amount":{"type":"number","description":"Amount of the transaction's row in the linked invoice.","example":10.25},"supplier_vat_id":{"type":"string","description":"Supplier VAT ID.","example":"VT09138461"},"dri":{"type":"string","description":"DRI (Documento Riepilogativo) code.","example":"DRI00099881"},"vehicle_id":{"type":"string","description":"Vehicle ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}}},"Refuelings":{"properties":{"total":{"type":"integer","format":"int32","description":"It represents the total number of available items in the list.","example":168},"pages":{"type":"integer","format":"int32","description":"It represents the total number of available pages.","example":7},"page_size":{"type":"integer","format":"int32","description":"It represents the number of items per page.","example":25},"current_page":{"type":"integer","format":"int32","description":"It indicates the current page (the counter starts from zero).","example":0},"results_size":{"type":"integer","format":"int32","description":"It indicates the size of the array results.","example":25},"results":{"type":"array","items":{"$ref":"#/components/schemas/Refueling"}}}},"RefuelingType":{"type":"string","description":"The resource `type` to be used together with id.","enum":["transaction","vehicle","card"],"example":"card"},"TransactionDateType":{"type":"string","default":"TRANSACTION","description":"It determines the date to be considered for `fromDate` and `toDate` parameters.","enum":["TRANSACTION","SETTLEMENT","UPDATE"],"example":"TRANSACTION"},"RemoveAssignees":{"description":"Remove `Subscription` assignees JSON parameters.","properties":{"remove_assignees":{"type":"array","description":"List of `User` IDs to remove from assignees.","example":["XMPL1234-000001","XMPL1234-000002","XMPL1234-000003"],"items":{"type":"string"}}},"required":["remove_assignees"]},"RemoveTransactionCustomExportBulk":{"properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/TransactionCustomExportRemove"}}}},"TransactionCustomExportRemove":{"properties":{"id":{"type":"string","description":"The `TransactionCustomExport` ID","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"transaction_id":{"type":"string","description":"The `Transaction` ID","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"status":{"$ref":"#/components/schemas/CustomExportTransactionStatus","description":"The result of the `TransactionCustomExport` of `Transaction`","example":"SUCCESS"}}},"RemoveTransactionCustomExport":{"description":"Remove `TransactionCustomExport` JSON parameters.","properties":{"ids":{"type":"array","description":"A list of `TransactionCustomExport`Ids","example":["8uf79328-a7ae-4222-aa54-091ff7f429a7"],"items":{"type":"string"}}},"required":["ids"]},"RetrieveCustomExportTransaction":{"properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/TransactionCustomExportRetrieve"}}}},"TransactionCustomExportRetrieve":{"properties":{"id":{"type":"string","description":"The `TransactionCustomExport` ID","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"transaction_id":{"type":"string","description":"The `Transaction` ID","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"product":{"type":"string","description":"A product that exported list of `Transaction`","example":"SAP"},"export_timestamp":{"type":"string","description":"The date and time when the `Transaction` was exported.","example":"2017-06-01T12:48:40Z"}}},"TransactionCustomExportBulk":{"description":"Get `TransactionCustomExport` JSON parameters.","properties":{"transaction_ids":{"type":"array","description":"The list of `Transaction` ID, max item 1000","example":["7bf79328-a7ae-4222-aa54-091ff7f429a7","2d65bd5e-3fdf-4002-b166-bde7fb8863fa"],"items":{"type":"string"}}},"required":["transaction_ids"]},"Channel":{"type":"string","enum":["WEB","MOBILE"]},"UserAccessMode":{"properties":{"channel":{"$ref":"#/components/schemas/Channel","description":"The channel for which the access mode applies.","example":"WEB"},"auth_mode":{"$ref":"#/components/schemas/UserAuthMode","description":"The authentication mode required for the `User` while accessing from the given channel.","example":"SSO"}},"required":["auth_mode","channel"]},"UserAccessModeList":{"properties":{"user_access_mode":{"type":"array","items":{"$ref":"#/components/schemas/UserAccessMode"}}}},"UserAuthMode":{"type":"string","enum":["SOLDO","SSO"]},"Addresses":{"properties":{"total":{"type":"integer","format":"int32","description":"It represents the total number of available items in the list.","example":168},"pages":{"type":"integer","format":"int32","description":"It represents the total number of available pages.","example":7},"page_size":{"type":"integer","format":"int32","description":"It represents the number of items per page.","example":25},"current_page":{"type":"integer","format":"int32","description":"It indicates the current page (the counter starts from zero).","example":0},"results_size":{"type":"integer","format":"int32","description":"It indicates the size of the array results.","example":25},"results":{"type":"array","items":{"$ref":"#/components/schemas/Address"}}}},"Autotags":{"properties":{"total":{"type":"integer","format":"int32","description":"It represents the total number of available items in the list.","example":168},"pages":{"type":"integer","format":"int32","description":"It represents the total number of available pages.","example":7},"page_size":{"type":"integer","format":"int32","description":"It represents the number of items per page.","example":25},"current_page":{"type":"integer","format":"int32","description":"It indicates the current page (the counter starts from zero).","example":0},"results_size":{"type":"integer","format":"int32","description":"It indicates the size of the array results.","example":25},"results":{"type":"array","items":{"$ref":"#/components/schemas/Autotag"}}}},"CardRulePresets":{"properties":{"total":{"type":"integer","format":"int32","description":"It represents the total number of available items in the list.","example":168},"pages":{"type":"integer","format":"int32","description":"It represents the total number of available pages.","example":7},"page_size":{"type":"integer","format":"int32","description":"It represents the number of items per page.","example":25},"current_page":{"type":"integer","format":"int32","description":"It indicates the current page (the counter starts from zero).","example":0},"results_size":{"type":"integer","format":"int32","description":"It indicates the size of the array results.","example":25},"results":{"type":"array","items":{"$ref":"#/components/schemas/CardRulePreset"}}}},"OutOfOfficeDelegations":{"properties":{"total":{"type":"integer","format":"int32","description":"It represents the total number of available items in the list.","example":168},"pages":{"type":"integer","format":"int32","description":"It represents the total number of available pages.","example":7},"page_size":{"type":"integer","format":"int32","description":"It represents the number of items per page.","example":25},"current_page":{"type":"integer","format":"int32","description":"It indicates the current page (the counter starts from zero).","example":0},"results_size":{"type":"integer","format":"int32","description":"It indicates the size of the array results.","example":25},"results":{"type":"array","items":{"$ref":"#/components/schemas/OutOfOfficeDelegation"}}}},"Expense":{"properties":{"user_id":{"type":"string","description":"The ID of the `User` (sortable: no).","example":"XMPL1234-000001"},"user_name":{"type":"string","description":"The name of the `User` (sortable: yes).","example":"JOHN"},"user_surname":{"type":"string","description":"The surname of the `User` (sortable: yes).","example":"DOE"},"job_title":{"type":"string","description":"The job title of the `User` (sortable: yes).","example":"CTO"},"to_review_transaction":{"type":"integer","format":"int64","description":"The number of the `Transaction` items in status `TO_REVIEW` (sortable: no).","example":1},"reviewed_transaction":{"type":"integer","format":"int64","description":"The number of the `Transaction` items in status `REVIEWED` (sortable: no).","example":2},"exported_transaction":{"type":"integer","format":"int64","description":"The number of the `Transaction` items in status `EXPORTED` (sortable: no).","example":1},"total_transaction":{"type":"integer","format":"int64","description":"The number of `Transaction` items (sortable: no).","example":3}}},"Expenses":{"properties":{"total":{"type":"integer","format":"int32","description":"It represents the total number of available items in the list.","example":168},"pages":{"type":"integer","format":"int32","description":"It represents the total number of available pages.","example":7},"page_size":{"type":"integer","format":"int32","description":"It represents the number of items per page.","example":25},"current_page":{"type":"integer","format":"int32","description":"It indicates the current page (the counter starts from zero).","example":0},"results_size":{"type":"integer","format":"int32","description":"It indicates the size of the array results.","example":25},"results":{"type":"array","items":{"$ref":"#/components/schemas/Expense"}}}},"ExpenseReports":{"properties":{"total":{"type":"integer","format":"int32","description":"It represents the total number of available items in the list.","example":168},"pages":{"type":"integer","format":"int32","description":"It represents the total number of available pages.","example":7},"page_size":{"type":"integer","format":"int32","description":"It represents the number of items per page.","example":25},"current_page":{"type":"integer","format":"int32","description":"It indicates the current page (the counter starts from zero).","example":0},"results_size":{"type":"integer","format":"int32","description":"It indicates the size of the array results.","example":25},"results":{"type":"array","items":{"$ref":"#/components/schemas/ExpenseReport"}}}},"ExpenseReportStatus":{"type":"string","description":"The `ExpenseReport` status.","enum":["PROCESSED","CANCELLED","TO_BE_PROCESSED"]},"TagDictionaries":{"properties":{"total":{"type":"integer","format":"int32","description":"It represents the total number of available items in the list.","example":168},"pages":{"type":"integer","format":"int32","description":"It represents the total number of available pages.","example":7},"page_size":{"type":"integer","format":"int32","description":"It represents the number of items per page.","example":25},"current_page":{"type":"integer","format":"int32","description":"It indicates the current page (the counter starts from zero).","example":0},"results_size":{"type":"integer","format":"int32","description":"It indicates the size of the array results.","example":25},"results":{"type":"array","items":{"$ref":"#/components/schemas/TagDictionary"}}}},"RequestItem":{"properties":{"id":{"type":"string","description":"The `Request` ID (sortable: no).","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"name":{"type":"string","description":"The name of the `Request` (sortable: no).","example":"Supplier name"},"description":{"type":"string","description":"The description of the `Request` (sortable: no).","example":"Example description"},"requester":{"type":"string","description":"The ID of the `User` that makes the `Request` (sortable: no).","example":"XMPL1234-000001"},"status":{"$ref":"#/components/schemas/RequestStatus","description":"The status of the `Request` (sortable: no).","example":"APPROVED"},"payment_method":{"$ref":"#/components/schemas/PaymentMethod","description":"The method of payment of the `Request` (sortable: no).","example":"Temporary card"},"type":{"$ref":"#/components/schemas/RequestType","description":"The type of the `Request` (sortable: no).","example":"GOODS_OR_SERVICES"},"amount":{"type":"number","description":"The total amount of the `Request` (sortable: no).","example":10.25},"currency":{"$ref":"#/components/schemas/ISO4217Currency","description":"The currency of the total amount of the `Request` (sortable: no).","example":"EUR"},"creation_time":{"type":"string","description":"The date and time when the `Request` was created (sortable: yes).","example":"2017-06-01T12:48:40Z"},"last_update_time":{"type":"string","description":"The date and time when the `Request` was last updated (sortable: yes).","example":"2017-06-01T12:48:40Z"}}},"Requests":{"properties":{"total":{"type":"integer","format":"int32","description":"It represents the total number of available items in the list.","example":168},"pages":{"type":"integer","format":"int32","description":"It represents the total number of available pages.","example":7},"page_size":{"type":"integer","format":"int32","description":"It represents the number of items per page.","example":25},"current_page":{"type":"integer","format":"int32","description":"It indicates the current page (the counter starts from zero).","example":0},"results_size":{"type":"integer","format":"int32","description":"It indicates the size of the array results.","example":25},"results":{"type":"array","items":{"$ref":"#/components/schemas/RequestItem"}}}},"Subscriptions":{"properties":{"total":{"type":"integer","format":"int32","description":"It represents the total number of available items in the list.","example":168},"pages":{"type":"integer","format":"int32","description":"It represents the total number of available pages.","example":7},"page_size":{"type":"integer","format":"int32","description":"It represents the number of items per page.","example":25},"current_page":{"type":"integer","format":"int32","description":"It indicates the current page (the counter starts from zero).","example":0},"results_size":{"type":"integer","format":"int32","description":"It indicates the size of the array results.","example":25},"results":{"type":"array","items":{"$ref":"#/components/schemas/Subscription"}}}},"Tags":{"properties":{"total":{"type":"integer","format":"int32","description":"It represents the total number of available items in the list.","example":168},"pages":{"type":"integer","format":"int32","description":"It represents the total number of available pages.","example":7},"page_size":{"type":"integer","format":"int32","description":"It represents the number of items per page.","example":25},"current_page":{"type":"integer","format":"int32","description":"It indicates the current page (the counter starts from zero).","example":0},"results_size":{"type":"integer","format":"int32","description":"It indicates the size of the array results.","example":25},"results":{"type":"array","items":{"$ref":"#/components/schemas/Tag"}}}},"TransactionCustomExport":{"properties":{"id":{"type":"string","description":"The `TransactionCustomExport` ID","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"transaction_id":{"type":"string","description":"The `Transaction` ID (sortable: yes).","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"product":{"type":"string","description":"A product that exported list of `Transaction`","example":"SAP"},"export_timestamp":{"type":"string","description":"The date and time when the `Transaction` was exported.","example":"2017-06-01T12:48:40Z"}}},"TransactionCustomExports":{"properties":{"total":{"type":"integer","format":"int32","description":"It represents the total number of available items in the list.","example":168},"pages":{"type":"integer","format":"int32","description":"It represents the total number of available pages.","example":7},"page_size":{"type":"integer","format":"int32","description":"It represents the number of items per page.","example":25},"current_page":{"type":"integer","format":"int32","description":"It indicates the current page (the counter starts from zero).","example":0},"results_size":{"type":"integer","format":"int32","description":"It indicates the size of the array results.","example":25},"results":{"type":"array","items":{"$ref":"#/components/schemas/TransactionCustomExport"}}}},"Vehicles":{"properties":{"total":{"type":"integer","format":"int32","description":"It represents the total number of available items in the list.","example":168},"pages":{"type":"integer","format":"int32","description":"It represents the total number of available pages.","example":7},"page_size":{"type":"integer","format":"int32","description":"It represents the number of items per page.","example":25},"current_page":{"type":"integer","format":"int32","description":"It indicates the current page (the counter starts from zero).","example":0},"results_size":{"type":"integer","format":"int32","description":"It indicates the size of the array results.","example":25},"results":{"type":"array","items":{"$ref":"#/components/schemas/Vehicle"}}}},"WalletAutotransferPresetItems":{"properties":{"id":{"type":"string","description":"The unique identifier of the `AutoTransferPreset`. (Sortable: No).","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"name":{"type":"string","description":"The name of the `AutoTransferPreset`. (Sortable: No)","example":"DefaultPreset"},"description":{"type":"string","description":"The description of `AutoTransferPreset` (sortable: no).","example":"Default CardRule preset policy"},"type":{"$ref":"#/components/schemas/WalletPresetType","description":"The type of the `AutoTransferPreset`.","example":"PERIODIC"},"currency":{"type":"string","description":"The currency used in the `AutoTransferPreset`.","example":"EUR"},"number_of_assigned_wallets":{"type":"integer","format":"int32","description":"The number of wallets assigned to the `AutoTransferPreset`.","example":2},"wallet_from":{"type":"string","description":"The from wallet used for the `AutoTransferPreset`.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"creation_time":{"type":"string","description":"The date and time when the `AutotransferPreset` was created.","example":"2017-06-01T12:48:40Z"},"last_update_time":{"type":"string","description":"The date and time the `AutoTransferPreset` was last updated.","example":"2017-06-01T12:48:40Z"}}},"WalletAutotransferPresets":{"properties":{"total":{"type":"integer","format":"int32","description":"It represents the total number of available items in the list.","example":168},"pages":{"type":"integer","format":"int32","description":"It represents the total number of available pages.","example":7},"page_size":{"type":"integer","format":"int32","description":"It represents the number of items per page.","example":25},"current_page":{"type":"integer","format":"int32","description":"It indicates the current page (the counter starts from zero).","example":0},"results_size":{"type":"integer","format":"int32","description":"It indicates the size of the array results.","example":25},"results":{"type":"array","items":{"$ref":"#/components/schemas/WalletAutotransferPresetItems"}}}},"WebhookSubscriptions":{"properties":{"total":{"type":"integer","format":"int32","description":"It represents the total number of available items in the list.","example":168},"pages":{"type":"integer","format":"int32","description":"It represents the total number of available pages.","example":7},"page_size":{"type":"integer","format":"int32","description":"It represents the number of items per page.","example":25},"current_page":{"type":"integer","format":"int32","description":"It indicates the current page (the counter starts from zero).","example":0},"results_size":{"type":"integer","format":"int32","description":"It indicates the size of the array results.","example":25},"results":{"type":"array","items":{"$ref":"#/components/schemas/WebhookSubscription"}}}},"UpdateCardRules":{"description":"A `CardRule` representation.","properties":{"name":{"$ref":"#/components/schemas/CardRuleName","description":"The name of the `CardRule` to update. To follow the implications of each rule when enabled (`enabled=true`) on a card:\n- `OpenCloseMasterLock`, card is locked and only admins can unlock it\n- `OpenClose`, card is locked and any user who have access to the card can unlock it\n- `OpenCloseAfterOneTx`, card is automatically locked after each transaction\n- `Online`, card can spend online\n- `Contactless`, card can spend contactless","example":"CashPoint"},"enabled":{"type":"boolean","description":"It determines whether the rule is enabled.","example":true}},"required":["enabled","name"]},"StatementDownloadUrl":{"properties":{"presigned_url":{"type":"string","format":"uri","description":"The presigned url where to download the `Statement`.","example":"https://my-demo-bucket.s3.amazonaws.com/example.txt?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAIOSFODNN7EXAMPLE%2F20250416%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20250416T083000Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=abcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890"}}},"DownloadStatement":{"description":"Download `statement` JSON parameters.","properties":{"year":{"type":"integer","format":"int32","example":2025,"maximum":2099,"minimum":2015},"month":{"$ref":"#/components/schemas/Month","description":"The reference month of the `Statement`.","example":"JANUARY"},"file_type":{"$ref":"#/components/schemas/StatementFileType","description":"The generated `Statement` file type.","example":"PDF"},"currency":{"$ref":"#/components/schemas/ISO4217SupportedCurrency","description":"The [ISO 4217](https://www.six-group.com/en/products-services/financial-information/data-standards.html#scrollTo=maintenance-agency) code of the currency of the `Statement` to search for.","example":"EUR"}},"required":["currency","file_type","month","year"]},"Month":{"type":"string","enum":["JANUARY","FEBRUARY","MARCH","APRIL","MAY","JUNE","JULY","AUGUST","SEPTEMBER","OCTOBER","NOVEMBER","DECEMBER"]},"StatementFileType":{"type":"string","enum":["PDF","XLSX","CSV"]},"Statement":{"properties":{"year":{"type":"integer","format":"int32","description":"The reference year for `Statement`.","example":2025},"month":{"$ref":"#/components/schemas/Month","description":"The reference month for `Statement`.","example":"JANUARY"},"currency":{"$ref":"#/components/schemas/ISO4217SupportedCurrency","description":"The [ISO 4217](https://www.six-group.com/en/products-services/financial-information/data-standards.html#scrollTo=maintenance-agency) code of the currency of the `Statement`.","example":"EUR"},"file_types":{"type":"array","description":"The generated `Statement` file types.","items":{"example":"PDF"}}}},"Statements":{"properties":{"total":{"type":"integer","format":"int32","description":"It represents the total number of available items in the list.","example":168},"results":{"type":"array","items":{"$ref":"#/components/schemas/Statement"}}}},"VatRates":{"properties":{"total":{"type":"integer","format":"int32","description":"It represents the total number of available items in the list.","example":168},"pages":{"type":"integer","format":"int32","description":"It represents the total number of available pages.","example":7},"page_size":{"type":"integer","format":"int32","description":"It represents the number of items per page.","example":25},"current_page":{"type":"integer","format":"int32","description":"It indicates the current page (the counter starts from zero).","example":0},"results_size":{"type":"integer","format":"int32","description":"It indicates the size of the array results.","example":25},"results":{"type":"array","items":{"$ref":"#/components/schemas/VatRate"}}}},"UpdateTransactionAttachment":{"description":"Update `TransactionAttachment` JSON parameters.","properties":{"read_only":{"type":"boolean","description":"true if the attachment is not editable","example":false},"attachment_type":{"$ref":"#/components/schemas/TransactionAttachmentType","description":"The type of the attachment","example":"INVOICE"},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Generic map of custom metadata"}}},"TransactionAttachments":{"properties":{"attachments":{"type":"array","items":{"$ref":"#/components/schemas/TransactionAttachment"}}}},"EntityIdDTO":{"properties":{"id":{"type":"string","description":"The resource ID.","example":"6853e657-c797-4985-8d6b-5425d4e51df8"}}},"TransactionItem":{"properties":{"id":{"type":"string","description":"The `Transaction` ID (sortable: yes).","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"wallet_id":{"type":"string","description":"The ID of the `Wallet` from where the `Transaction` has been authorised (sortable: no).","example":"6853e657-c797-4985-8d6b-5425d4e51df8"},"wallet_name":{"type":"string","description":"The name of the `Wallet` from where the `Transaction` has been authorised (sortable: no).","example":"John Doe"},"status":{"$ref":"#/components/schemas/TransactionStatus","description":"The status of the `Transaction` (sortable: yes).","example":"Settled"},"category":{"$ref":"#/components/schemas/TransactionCategory","description":"The category of the `Transaction` (sortable: yes).","example":"Payment"},"transaction_sign":{"$ref":"#/components/schemas/TransactionSign","description":"The sign of the transaction amount (Negative, Positive, None) (sortable: no).","example":"Negative"},"purchase_id":{"type":"string","description":"The `Purchase` ID (sortable: no).","example":"6853e657-c797-4985-8d6b-5425d4e51df8"},"amount":{"type":"number","description":"The amount of the `Transaction` in the currency of the `Wallet` (sortable: no).","example":10.25},"amount_currency":{"$ref":"#/components/schemas/ISO4217Currency","description":"The currency [ISO 4217](https://www.six-group.com/en/products-services/financial-information/data-standards.html#scrollTo=maintenance-agency) code of the amount (sortable: no).","example":"EUR"},"tx_amount":{"type":"number","description":"The amount of the `Transaction` in the currency of the `Merchant` (sortable: no).","example":10.25},"tx_amount_currency":{"$ref":"#/components/schemas/ISO4217Currency","description":"The currency [ISO 4217](https://www.six-group.com/en/products-services/financial-information/data-standards.html#scrollTo=maintenance-agency) code of the `tx_amount` (sortable: no).","example":"EUR"},"fee_amount":{"type":"number","description":"The amount of the `Transaction` fee in the currency of the `Wallet` (sortable: no).","example":10.25},"fee_currency":{"$ref":"#/components/schemas/ISO4217Currency","description":"The currency [ISO 4217](https://www.six-group.com/en/products-services/financial-information/data-standards.html#scrollTo=maintenance-agency) code of the fee_amount (sortable: no).","example":"EUR"},"exchange_rate":{"type":"number","description":"The exchange rate applied at the `Settled` status (sortable: no).","example":1},"auth_exchange_rate":{"type":"number","description":"The exchange rate applied at the `Authorised` status (sortable: no).","example":1},"expense_status":{"$ref":"#/components/schemas/ExpenseStatus","description":"The status of approval of the expense (sortable: no).","example":"APPROVED"},"expense_type":{"$ref":"#/components/schemas/ExpenseType","description":"The type of the expense (sortable: no).","example":"TRAVEL_AND_ENTERTAINMENT"},"expense_date":{"type":"string","description":"The date and time of the last review of the expense (sortable: no).","example":"2017-06-01T12:48:40Z"},"expense_reviewer":{"type":"string","description":"The ID of the `User` who reviewed the expense (sortable: no).","example":"XMPL1234-000001"},"expense_approved_amount":{"type":"number","description":"The expense amount that a reviewer has approved (sortable: no).","example":10.25},"expense_report_id":{"type":"string","description":"The ID of the `ExpenseReport` the `Transaction` is included into (sortable: no).","example":"c861cc24-6663-410f-8c78-73f886fff4ef"},"date":{"type":"string","description":"The date and time of the `Transaction` at the `Authorised` status (sortable: yes).","example":"2017-06-01T12:48:40Z"},"settlement_date":{"type":"string","description":"The date and time of the `Transaction` at the `Settled` status (sortable: yes).","example":"2017-06-01T12:48:40Z"},"update_time":{"type":"string","description":"The date and time of the last update to the `Transaction` (sortable: yes).","example":"2017-06-01T12:48:40Z"},"merchant":{"$ref":"#/components/schemas/TransactionMerchant","description":"The name of the Merchant of the transaction (only valid for `Payment`, `Withdrawal`, `Refund` transaction categories) (sortable: no)."},"merchant_category":{"$ref":"#/components/schemas/TransactionMerchantCategory","description":"The category of the `Merchant` of the `Transaction` (only valid for `Payment`, `Withdrawal`, `Refund` transaction categories) (sortable: no)."},"tags":{"type":"array","description":"The list of the `Tags` of the `Transaction`.","items":{"$ref":"#/components/schemas/TransactionTag"}},"card_id":{"type":"string","description":"The ID of the `Card` used for the `Transaction` (sortable: no).","example":"6853e657-c797-4985-8d6b-5425d4e51df8"},"masked_pan":{"type":"string","description":"The masked PAN of the `Card` used for the `Transaction` (sortable: yes).","example":"123456******1234"},"owner_name":{"type":"string","description":"The name of the cardholder who made the transaction (only available when `owner_type` is `employee`) (sortable: no).","example":"John"},"owner_surname":{"type":"string","description":"The surname of the cardholder who made the transaction (only available when `owner_type` is `employee`) (sortable: no).","example":"Smith"},"owner_type":{"$ref":"#/components/schemas/TransactionOwnerType","description":"The owner type (`company`, `employee`) (sortable: no).","example":"company"},"owner_id":{"type":"string","description":"The ID of the Cardholder who made the `Transaction` (only available when `owner_type` is `employee`) (sortable: no).","example":"XMPL1234-000003"},"custom_reference_id":{"type":"string","description":"The custom reference ID of the Cardholder who made the `Transaction` (only available when `owner_type` is `employee`) (sortable: no).","example":"123456-user-1"},"group_id":{"type":"string","description":"The ID of the `Group` the `Transaction` belongs to (sortable: no). ","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"},"has_attachments":{"type":"boolean","description":"It determines whether the transaction has one or more `TransactionAttachments` (sortable: no).","example":false},"trx_owner_id":{"type":"string","description":"For User `Card` transactions, when `owner_type` is `employee`, is the cardholder ID, for Company `Card`, when `owner_type` is `company`, is empty or one of the `Card` assignees (sortable: no).","example":"XMPL1234-000003"},"metadata_ids":{"type":"array","description":"A list of IDs related to custom generated `Metadata` of the `Transaction` (sortable: no).","example":["express"],"items":{"type":"string"}},"fuel_details":{"$ref":"#/components/schemas/TransactionFuelDetails","description":"The fuel details of the `Transaction`  (sortable: no)."},"vat_percentage":{"type":"number","description":"The VAT percentage applied (sortable: no).","example":15},"vat_amount":{"type":"number","description":"The amount of the VAT in the currency of the `Wallet` (sortable: no).","example":10.25},"vat_currency":{"$ref":"#/components/schemas/ISO4217Currency","description":"The currency [ISO 4217](https://www.six-group.com/en/products-services/financial-information/data-standards.html#scrollTo=maintenance-agency) code of the vat_amount (sortable: no).","example":"EUR"},"user_notes":{"type":"string","description":"The notes defined by the `User` (sortable: no)."},"notes":{"type":"string","description":"The notes defined by Soldo (sortable: no)."},"direct_url":{"type":"string","description":"The direct URL to the transaction details page (sortable: no)."},"flags":{"type":"array","description":"List of strings: `forUser`, `forAdmin` or empty. It determines for which kinds of `Users` the transaction is flagged to (sortable: no).","example":["forUser"],"items":{"type":"string"}},"payment_method":{"$ref":"#/components/schemas/TransactionPaymentMethod","description":"The payment method of the `Transaction`.","example":"ONLINE_ADS"},"payment_method_id":{"type":"string","description":"The ID of the payment method, could be the ID of a `Subscription`, `OnlineAds` or `Purchase` resource (sortable: no).","example":"6853e657-c797-4985-8d6b-5425d4e51df8"},"expense_category":{"$ref":"#/components/schemas/ExpenseCategory","description":"The `ExpenseCategory` assigned to the `Transaction`."},"tax_rate":{"$ref":"#/components/schemas/VatRate","description":"The `Transaction`'s `VatRate`."},"split":{"type":"boolean","description":"It determines whether the transaction has been split (sortable: no).","example":false},"tx_id":{"type":"string","description":"The transaction's internal id (the same ID that can be found on reports and the advanced details section of a `Transaction`).","example":"5-857211147-150603333585014265"},"payment_trn_code":{"type":"string","description":"The Transaction Reference Number (TRN) of the outbound payment generated by Soldo. Available for `SEPA`, `SEPA_INSTANT`.","example":"1234567890123456789012345678IT"},"carbon_emissions":{"$ref":"#/components/schemas/TransactionCarbonEmissionInfo","description":"The amount of CO2e emissions generated as a result of the `Transaction`."},"required_information":{"$ref":"#/components/schemas/SearchTransactionRequiredInformation","description":"It indicates whether a transaction has (or doesn’t have) all details marked as mandatory in the ‘Reminders’ section filled in.","example":"COMPLETE"},"reimbursement_expense_report_id":{"type":"string","description":"The ID of the ExpenseReport that was reimbursed by this payment. Note to developer: if this ID is not null this payment can be considered a reimbursement. (sortable: no)."},"invoice":{"$ref":"#/components/schemas/Invoice","description":"The invoice to which this transaction relates"},"source":{"$ref":"#/components/schemas/Source","description":"Info about the origin of the `Transaction` (this applies for `InboundFasterPayment`, `InboundFasterPaymentReversal`, `Load`, `LoadReversal` and `Wiretransfer`)."},"custom_export":{"type":"array","description":"The info generated as a result of the custom export `Transaction`.","items":{"$ref":"#/components/schemas/CustomExport"}},"out_spending_policy":{"$ref":"#/components/schemas/TransactionSpendingPolicyMetadata","description":"The outSpendingPolicy of the `Transaction`."},"details":{"$ref":"#/components/schemas/TransactionItemDetails","description":"The details of the `Transaction`."},"split_transactions":{"type":"array","description":"The list of `SplitTransactionInfo`.","items":{"$ref":"#/components/schemas/TransactionItemSplitInfo"}}}},"TransactionItemDetails":{"properties":{"tx_country":{"$ref":"#/components/schemas/ISO3166Country","description":"The [ISO 3166-1 alpha-3](https://www.iso.org/obp/ui/#search/code/) code of the country where the `Transaction` has been authorised.","example":"GBR"}}},"TransactionItemSplitInfo":{"properties":{"line_number":{"type":"integer","format":"int32","description":"The `Transaction`'s line number.","example":1},"amount":{"$ref":"#/components/schemas/TransactionAmount","description":"The `TransactionList`'s line amount."},"vat_amount":{"$ref":"#/components/schemas/TransactionAmount","description":"The `TransactionList`'s line VAT amount."},"expense_type":{"$ref":"#/components/schemas/ExpenseType","description":"The type of the expense.","example":"TRAVEL_AND_ENTERTAINMENT"},"employee":{"$ref":"#/components/schemas/EntityIdDTO","description":"The `User` which the transaction line is assigned to."},"expense_category":{"$ref":"#/components/schemas/EntityIdDTO","description":"The `ExpenseCategory`."},"tax_rate":{"$ref":"#/components/schemas/EntityIdDTO","description":"The `VATRate`."},"tags":{"type":"array","description":"The `Tags`.","items":{"$ref":"#/components/schemas/TransactionTag"}},"approved_amount":{"$ref":"#/components/schemas/TransactionAmount","description":"The `TransactionList`'s line amount approved in policy."},"rejected_amount":{"$ref":"#/components/schemas/TransactionAmount","description":"The `TransactionList`'s line amount rejected in policy."}}},"Transactions":{"properties":{"total":{"type":"integer","format":"int32","description":"It represents the total number of available items in the list.","example":168},"pages":{"type":"integer","format":"int32","description":"It represents the total number of available pages.","example":7},"page_size":{"type":"integer","format":"int32","description":"It represents the number of items per page.","example":25},"current_page":{"type":"integer","format":"int32","description":"It indicates the current page (the counter starts from zero).","example":0},"results_size":{"type":"integer","format":"int32","description":"It indicates the size of the array results.","example":25},"results":{"type":"array","items":{"$ref":"#/components/schemas/TransactionItem"}}}},"SearchTransactionResourceType":{"type":"string","description":"The resource `type` to be used together with id.","enum":["company","employee","wallet","card","subscription","onlineAd","purchase"],"example":"card"},"SearchTransactionDateType":{"type":"string","default":"TRANSACTION","description":"It determines the date to be considered for `fromDate` and `toDate` parameters.","enum":["TRANSACTION","SETTLEMENT","UPDATE","REVIEW_TIME","CUSTOM_EXPORT_TIME"],"example":"TRANSACTION"},"SearchTransactionCategory":{"type":"string","description":"It determines the filter by category of the transaction, multiple categories can be included.","enum":["Billing","Chargeback","Conversion","Fee","FeeReversal","InboundFasterPayment","InboundFasterPaymentReversal","Load","LoadReversal","MileageReimbursement","NotRecognized","Payment","Rebalance","RecurringBilling","Refund","SoldoActivity","SoldoCreditOperation","SoldoDebitOperation","Transfer","Wiretransfer","Withdrawal"]},"SearchTransactionPaymentMethod":{"type":"string","description":"It determines the filter by payment method of the transaction, multiple payment methods can be included. `OUT_OF_PLATFORM_COMPANY` and `OUT_OF_PLATFORM_PERSONAL` are not included by default.","enum":["USER","COMPANY","PURCHASE","SUBSCRIPTION","ONLINE_ADS","OUT_OF_PLATFORM_COMPANY","OUT_OF_PLATFORM_PERSONAL","WIRETRANSFER"]},"ExportStatus":{"type":"string","description":"The export status of the expense.","enum":["EXPORTED","NOT_EXPORTED"],"example":"EXPORTED"},"UpdateAddress":{"description":"Update `Address` JSON parameters.","properties":{"recipient":{"type":"string","description":"The recipient of the addressee.","example":"JohnSmith"},"name":{"type":"string","description":"The actual name of the `Address`.","example":"Actual address of John"},"line1":{"type":"string","description":"The primary street of the `Address`.","example":"Foo street 33"},"line2":{"type":"string","description":"The optional secondary street.","example":"Second floor"},"country":{"$ref":"#/components/schemas/ISO3166Country","description":"The country code in [ISO 3166-1 alpha-3](https://www.iso.org/obp/ui/#search/code/) standard."},"county":{"type":"string","description":"The county code.","example":"00000"},"city":{"type":"string","description":"The city name.","example":"London"},"post_code":{"type":"string","description":"The post code of the city.","example":"00000"},"delivery_phone_number":{"type":"string","description":"The delivery phone including the country code.","example":"+44123323232"},"default_shipping":{"type":"boolean","description":"It is `true` if it's the default shipping address. You cannot set this as 'false', but you can elect a new one that will replace it as default.","enum":["true"],"example":true},"cards_to_link":{"type":"array","items":{"description":"The list of the `Card` ID to link to the address","example":["7bf79328-a7ae-4222-aa54-091ff7f429a7","2d65bd5e-3fdf-4002-b166-bde7fb8863fa"]}}},"required":["country"]},"UpdateAutotag":{"description":"Update `Autotag` JSON parameters.","properties":{"name":{"type":"string","description":"The name of the `Autotag`.","example":"Autotag"},"operation":{"$ref":"#/components/schemas/AutotagOperation","description":"The logical operator applied to the `Criteria`."},"criteria":{"type":"array","description":"The list of `Criteria` that need to be satisfied in order for the `Autotag` to be executed.","items":{"$ref":"#/components/schemas/AutotagCriteria"}},"expense_category_id":{"type":"string","description":"The ID of the `ExpenseCategory` of to be assigned to a `Transaction` satisfying the `Criteria`.","example":"6853e657-c797-4985-8d6b-5425d4e51df8"},"tax_rate_id":{"type":"string","description":"The ID of the `VATRate` to be assigned to a `Transaction` satisfying the `Criteria`.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"tag_ids":{"type":"array","description":"The IDs of the `Tag` and related `List` to be assigned to a `Transaction` satisfying the `Criteria`.","items":{"$ref":"#/components/schemas/AutotagTag"}},"enabled":{"type":"boolean","description":"It determines whether the `Autotag` rule is enabled (if a rule is not enabled, it won't be executed)."}}},"UpdateBusinessTripDetails":{"description":"Update `BusinessTrip` JSON parameters.","properties":{"request_timestamp":{"type":"integer","format":"int64","description":"The epoch timestamp in millis. This is checked in Soldo. Requests with timestamp older than 5 seconds will be rejected.","example":1576850500000},"name":{"type":"string","description":"The `BusinessTrip` name.","example":"EXAMPLE BUSINESS TRIP"},"description":{"type":"string","description":"The `BusinessTrip` description.","example":"EXAMPLE BUSINESS TRIP DESCRIPTION"},"destination":{"type":"string","description":"The `BusinessTrip` destination.","example":"monte fato"},"from_date":{"type":"string","description":"The `BusinessTrip` start date and time.","example":"2017-06-01T12:48:40Z"},"to_date":{"type":"string","description":"The `BusinessTrip` end date and time.","example":"2017-06-01T12:48:40Z"}}},"UpdateBusinessTripExpenseAllocation":{"description":"Update `BusinessTrip` JSON parameters.","properties":{"request_timestamp":{"type":"integer","format":"int64","description":"The epoch timestamp in millis. This is checked in Soldo. Requests with timestamp older than 5 seconds will be rejected.","example":1576850500000},"expense_allocation":{"type":"array","description":"The `BusinessTrip` expense allocation to use.","items":{"$ref":"#/components/schemas/BusinessTripExpense"}}}},"UpdateBusinessTripPostActions":{"description":"Update `BusinessTrip` JSON parameters.","properties":{"request_timestamp":{"type":"integer","format":"int64","description":"The epoch timestamp in millis. This is checked in Soldo. Requests with timestamp older than 5 seconds will be rejected.","example":1576850500000},"unused_funds":{"$ref":"#/components/schemas/BusinessTripUnusedFunds","description":"The action to be performed about the `BusinessTrip` unused funds (sortable: no)."},"card_handling":{"$ref":"#/components/schemas/BusinessTripCardHandling","description":"The status of the `Card` at the end of the `BusinessTrip` (sortable: no)."}}},"UpdateBusinessTripTags":{"description":"Update `BusinessTrip` JSON parameters.","properties":{"request_timestamp":{"type":"integer","format":"int64","description":"The epoch timestamp in millis. This is checked in Soldo. Requests with timestamp older than 5 seconds will be rejected.","example":1576850500000},"tags":{"type":"array","description":"The IDs of the `Tag` and related `Dictionary` to be assigned to a `BusinessTrip`.","items":{"$ref":"#/components/schemas/BusinessTripTag"}}}},"UpdateCard":{"description":"Update `Card` JSON parameters.","properties":{"label":{"type":"string","description":"The new label of the `Card` (max 60 characters).","example":"CardLabel","maxLength":60},"vehicle_id":{"type":"string","description":"The `Vehicle` ID to be assigned to the `Card` - only valid for PLASTIC or FUEL cards (To remove a `Vehicle` set the value to an empty string).","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"shipping_address_id":{"type":"string","description":"The shipping `Address` ID to be assigned to the `Card` .","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"addCardAssignees":{"type":"array","description":"The assignees to be added for the `Card`.","example":["XMPL1234-000001","XMPL1234-000002","XMPL1234-000003"],"items":{"type":"string"}},"removeCardAssignees":{"type":"array","description":"The assignees to be remove for the `Card`.","example":["XMPL1234-000001","XMPL1234-000002","XMPL1234-000003"],"items":{"type":"string"}}}},"UpdateExpenseType":{"properties":{"type":{"$ref":"#/components/schemas/ExpenseType","description":"The type of the `Transaction` expense.","example":"TRAVEL_AND_ENTERTAINMENT"},"approver_id":{"type":"string","description":"The ID of the 'SuperAdmin' `user` who approves/rejects the `expenseReview`.","example":"XMPL1234-000003"}},"required":["approver_id","type"]},"UpdateContact":{"description":"Update `Contact` JSON parameters.","properties":{"type":{"$ref":"#/components/schemas/ContactType","description":"The type of the `Contact`","example":"SUPPLIER"},"user_id":{"type":"string","description":"The ID of the `User` the bank details are assigned to (only available for `Contacts` of type `EMPLOYEE`).","example":"XMPL1234-000001"},"account_info":{"type":"array","description":"The account info","items":{"$ref":"#/components/schemas/AccountInfoContact"}},"status":{"$ref":"#/components/schemas/ContactStatus","description":"The status of the `Contact`","example":"CREATED"}}},"UpdateOutOfOfficeDelegation":{"description":"Update `out_of_office` Request JSON parameters.","properties":{"request_timestamp":{"type":"integer","format":"int64","description":"The epoch timestamp in millis. This is checked in Soldo. Requests with timestamp older than 5 seconds will be rejected.","example":1576850500000},"delegate_id":{"type":"string","description":"The ID of the person covering for the delegator.","example":"XMPL1234-000002"},"from_date":{"type":"string","description":"Defines when the out_of_office entry starts. fromDate included.(i.e. greater than or equal to) (Format: `yyyy-MM-dd`).","example":"2020-04-06"},"to_date":{"type":"string","description":"Defines when the out_of_office entry ends. toDate included.(i.e. less than) (Format: `yyyy-MM-dd`).","example":"2020-04-06"},"features":{"type":"array","description":"The features of `out_of_office`.","items":{"$ref":"#/components/schemas/DelegationFeature"}}},"required":["delegate_id","features","request_timestamp"]},"UpdateUser":{"description":"Update `User` JSON parameters.","properties":{"job_title":{"type":"string","description":"The job title of the `User`.","example":"Business Strategist"},"mobile_number":{"type":"string","description":"The mobile number of the `User` including the country code.","example":"+44123323232"},"mobile_prefix":{"type":"string","description":"The mobile number country code, it must be the same included in the `mobile_number` field","example":"+44"},"email":{"type":"string","description":"The email of the `User` it is required for web credentials.","example":"jdoe@fake.soldo.com"},"enable_mobile_credential":{"type":"boolean","description":"True if the `User` has the mobile access enabled.","example":true},"enable_web_credential":{"type":"boolean","description":"True if the `User` has the web access enabled.","example":false},"custom_reference_id":{"type":"string","description":"The `User` reference in an external system.","example":"123456-user-1"},"reports_to":{"type":"string","description":"The ID of the `User` it reports to. In order to remove a previously set value, the field should be included in the payload as an empty string `\"reports_to\"`: `\"\"`.","example":"XMPL1234-000001"},"skip_credential_notification":{"type":"boolean","description":"Avoid to notify user upon credential status change driven by `enable_mobile_credential` or `enable_web_credential` flags.","example":true}}},"UpdateExpenseCategory":{"description":"Update `ExpenseCategory` Request JSON parameters.","properties":{"code":{"type":"string","description":"The code of the `ExpenseCategory`.","example":123},"name":{"type":"string","description":"The name of the `ExpenseCategory`.","example":"category-one"},"description":{"type":"string","description":"The description of the `ExpenseCategory`.","example":"An expense category"},"tax_rate_id":{"type":"string","description":"The ID of the VAT Rate linked to the `ExpenseCategory`.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"enabled":{"type":"boolean","description":"(true/false)it determines whether the `ExpenseCategory` is visible on the transaction detail.","example":true},"merchant_categories":{"type":"array","description":"A list of merchant categories this `ExpenseCategory` is auto-assigned to.","items":{"$ref":"#/components/schemas/MerchantCategory"}},"expense_type":{"$ref":"#/components/schemas/ExpenseType","description":"The type of expense this category is assigned to.","example":"company"}}},"ExpenseReportStatusUpdate":{"type":"string","enum":["PROCESSED","CANCELLED"]},"UpdateExpenseReport":{"description":"Update `ExpenseReport` Request JSON parameters.","properties":{"approver_id":{"type":"string","description":"The ID of the SuperAdmin `User` who approves/rejects the expense.","example":"XMPL1234-000003"},"status":{"$ref":"#/components/schemas/ExpenseReportStatusUpdate","description":"The status of the  `ExpenseReport`.","example":"PROCESSED"}}},"UpdateExpenseReviewProcess":{"description":"Update ExpenseReviewProcessStatus JSON parameters.","properties":{"name":{"type":"string","description":"The name of the `ExpenseReviewProcess`.","example":"EXPENSE REVIEW PROCESS"},"description":{"type":"string","description":"The description of the `ExpenseReviewProcess`.","example":"EXPENSE REVIEW PROCESS DESCRIPTION"},"conditions":{"type":"array","description":"The conditions a transaction needs to match in order to be included in the `ExpenseReviewProcess`.","items":{"$ref":"#/components/schemas/ExpenseReviewProcessCondition"}},"steps":{"type":"array","description":"The approval steps a transaction needs to go through in order to be reviewed.","items":{"$ref":"#/components/schemas/ExpenseReviewProcessStep"}}},"required":["conditions","description","name","steps"]},"ExpenseReviewProcessChangeStatus":{"type":"string","enum":["ACTIVE","INACTIVE"]},"UpdateExpenseReviewProcessStatus":{"description":"Update ExpenseReviewProcessStatus JSON parameters.","properties":{"status":{"$ref":"#/components/schemas/ExpenseReviewProcessChangeStatus","description":"The status of the `ExpenseReviewProcess`.","example":"ACTIVE"}},"required":["status"]},"UpdateExpenseReviewConfiguration":{"description":"Update Conf JSON parameters.","properties":{"request_timestamp":{"type":"integer","format":"int64","description":"The epoch timestamp in millis. This is checked in Soldo. Requests with timestamp older than 5 seconds will be rejected.","example":1576850500000},"start_date":{"type":"string","description":"The starting date from which the expenses can be reviewed.","example":"2017-06-01T12:48:40Z"},"activity_groups":{"type":"array","description":"It determines the filter by types of cards whose transactions are considered as expenses to be reviewed.","items":{"$ref":"#/components/schemas/ExpenseConfigurationActivityGroup"},"uniqueItems":true},"policy_url":{"type":"string","description":"The url of the company spending policy.","example":"https://www.policy.pdf"},"start_date_type":{"$ref":"#/components/schemas/ExpenseDateType","description":"It determines the filter by the type of date, multiple statuses can be included.","example":"TRANSACTION"},"enabled":{"type":"boolean","description":"It indicates ExpenseReview configuration is enabled.","example":false}},"required":["request_timestamp"]},"RequestExpenseInfo":{"properties":{"approver_id":{"type":"string","description":"The ID of the SuperAdmin `User` who approves/rejects the expense.","example":"XMPL1234-000003"},"message":{"type":"string","description":"The request info of the transaction expense review.","example":"Request info to employee"}},"required":["approver_id","message"]},"ExpenseStatusCategory":{"type":"string","enum":["AGAINST_POLICY","PERSONAL_EXPENSE","OTHER"]},"UpdateExpenseStatus":{"properties":{"status":{"$ref":"#/components/schemas/ExpenseStatus","description":"The expense status of the transaction.","example":"APPROVED"},"status_category":{"$ref":"#/components/schemas/ExpenseStatusCategory","description":"The status category of the transaction expense.","example":"AGAINST_POLICY"},"status_reason":{"type":"string","description":"The reason of the status.","example":"Expense violates company's reimbursement policy"},"approver_id":{"type":"string","description":"The ID of the SuperAdmin `User` who approves/rejects the `ExpenseReport`.","example":"XMPL1234-000003"}},"required":["approver_id","status","status_category"]},"UpdateGroup":{"description":"Update `Group` JSON parameters.","properties":{"name":{"type":"string","description":"The name of the `Group`.","example":"HR"},"custom_reference_id":{"type":"string","description":"The `Group` reference in an external system.","example":"hr-division-0001"},"note":{"type":"string","description":"Any notes about the `Group`.","example":"division"},"type":{"$ref":"#/components/schemas/GroupType","description":"The `Group`'s type.","example":"DIVISION"}}},"MileageReimbursementDetailsUpdateRequest":{"properties":{"vehicle_id":{"type":"string","description":"The ID of the `Vehicle` used, if registered.","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"},"reimbursement_rate":{"type":"number","description":"The rate to apply to the covered distance (measured in km) for the reimbursement, assuming the main `Wallet` currency. Required if `vehicle_id` is missing or if no reimbursement rate is set for the related `Vehicle`. Overridden if `vehicle_id` is set and a reimbursement rate is set for the related `Vehicle`.","example":0.45},"description":{"type":"string","description":"The description for the trip.","example":"Business trip: Rome - Florence - Turin - Milan"},"starting_point":{"type":"string","description":"The place where the travel started.","example":"Rome, Metropolitan City of Rome Capital, Italy"},"arrival_point":{"type":"string","description":"The point where the travel ended.","example":"Milan, Metropolitan City of Milan, Italy"},"multi_stops":{"type":"array","description":"The intermediate stops during the travel.","example":["Florence, Metropolitan City of Florence, Italy","Turin, Metropolitan City of Turin, Italy"],"items":{"type":"string"}},"distance":{"type":"number","description":"The travelled distance from the starting point to the arrival point (measured in km).","example":875.4},"round_trip":{"type":"boolean","description":"Whether the distance has been travelled twice due to a round trip.","example":true}},"required":["description","distance","round_trip"]},"UpdateMileageReimbursementTransaction":{"description":"Update `MileageReimbursement` `Transaction` JSON parameters.","properties":{"request_timestamp":{"type":"integer","format":"int64","description":"The epoch timestamp in millis. This is checked in Soldo. Requests with timestamp older than 5 seconds will be rejected.","example":1576850500000},"date":{"type":"string","description":"The date and time of the `Transaction`.","example":"2017-06-01T12:48:40Z"},"mileage":{"$ref":"#/components/schemas/MileageReimbursementDetailsUpdateRequest","description":"The details of the `MileageReimbursement`."}},"required":["date","mileage","request_timestamp"]},"UpdateOnlineAds":{"description":"Update `OnlineAd` JSON parameters.","properties":{"name":{"type":"string","description":"The name of the `OnlineAds`.","example":"Google Ads"},"description":{"type":"string","description":"The description `OnlineAds`.","example":"Google Ads Campaign"},"wallet_id":{"type":"string","description":"The `Wallet` ID associated to the `OnlineAds`.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"}}},"UpdateOutOfPlatformTransaction":{"description":"Update Out-Of-Platform `Transaction` JSON parameters.","properties":{"request_timestamp":{"type":"integer","format":"int64","description":"The epoch timestamp in millis. This is checked in Soldo. Requests with timestamp older than 5 seconds will be rejected.","example":1576850500000},"date":{"type":"string","description":"The date and time of the `Transaction`.","example":"2017-06-01T12:48:40Z"},"merchant_name":{"type":"string","description":"The name of the `Merchant` for the `Transaction`.","example":"SHH HOTEL LONDON"},"tx_amount":{"type":"number","description":"The amount of the `Transaction`, in the currency of the `Merchant`.","example":10.25},"tx_amount_currency":{"$ref":"#/components/schemas/ISO4217Currency","description":"The currency [ISO 4217](https://www.six-group.com/en/products-services/financial-information/data-standards.html#scrollTo=maintenance-agency) code of the `tx_amount`.","example":"EUR"},"exchange_rate":{"type":"number","description":"The exchange rate used to convert the `tx_amount` from the currency of the `Merchant` to the currency of the main `Wallet`. If needed and not provided, a default rate is derived from `date`.","example":1},"payment_method":{"$ref":"#/components/schemas/OutOfPlatformTransactionPaymentMethod","description":"The payment method of the `Transaction`.","example":"OUT_OF_PLATFORM_PERSONAL"}},"required":["date","merchant_name","payment_method","request_timestamp","tx_amount","tx_amount_currency"]},"UpdatePurchase":{"description":"Update `Purchase` JSON parameters.","properties":{"purchase_id":{"type":"string","description":"The `Purchase` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"title":{"type":"string","description":"The name of the `Purchase`","example":"Tech book"},"assignee_id":{"type":"string","description":"The ID of the `User` assigned to the `Purchase`.","example":"XMPL1234-000003"},"amount":{"type":"number","description":"The maximum spendable amount of the `Purchase`.","example":10.25},"description":{"type":"string","description":"The description of the `Purchase`.","example":"A purchase to approve"},"wallet_id":{"type":"string","description":"The ID of the `Wallet` the money are taken from, the funding source of the `Purchase`.","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"},"notes":{"type":"string","description":"The notes of the `Purchase`.","example":"Notes about the purchase request"},"max_tx_number":{"type":"integer","format":"int32","default":"1","description":"The total number of `Transactions` the temporary virtual `Card` can make (default is `1`).","example":3}},"required":["purchase_id"]},"UpdateRefueling":{"description":"Update `Refueling` JSON parameters.","properties":{"mileage":{"type":"integer","format":"int32","description":"The mileage of the `Vehicle`.","example":125000},"unit_price":{"type":"number","description":"The fuel unit price as specified on the `Transaction`.","example":1.41},"tx_fuel_type":{"$ref":"#/components/schemas/FuelType","description":"The fuel type specified on the `Transaction`.","example":"PETROL"},"quantity":{"type":"number","description":"The fuel quantity as specified on the `Transaction`.","example":80}}},"UpdateRequestFunds":{"allOf":[{"$ref":"#/components/schemas/UpdateRequestPayload"},{"type":"object","properties":{"request_timestamp":{"type":"integer","format":"int64","description":"The epoch timestamp in millis. This is checked in Soldo. Requests with timestamp older than 5 seconds will be rejected.","example":1576850500000},"amount":{"type":"number","description":"The total amount of the `Request` (sortable: no).","example":10.25},"currency":{"$ref":"#/components/schemas/ISO4217Currency","description":"The currency of the total amount of the `Request` (sortable: no).","example":"EUR"}}}],"required":["request_timestamp","type"]},"UpdateRequestGoodsOrServices":{"allOf":[{"$ref":"#/components/schemas/UpdateRequestPayload"},{"type":"object","properties":{"request_timestamp":{"type":"integer","format":"int64","description":"The epoch timestamp in millis. This is checked in Soldo. Requests with timestamp older than 5 seconds will be rejected.","example":1576850500000},"amount":{"type":"number","description":"The total amount of the `Request` (sortable: no).","example":10.25},"currency":{"$ref":"#/components/schemas/ISO4217Currency","description":"The currency of the total amount of the `Request` (sortable: no).","example":"EUR"},"number_transactions":{"type":"integer","format":"int32","description":"the number of transactions the `Request` was created (sortable: yes).","example":2}}}],"required":["request_timestamp","type"]},"UpdateRequestPayload":{"discriminator":{"propertyName":"type"},"properties":{"type":{"$ref":"#/components/schemas/RequestType","description":"The type of the `Request`."},"name":{"type":"string","description":"The name of the `Request` (sortable: no).","example":"Supplier name"},"description":{"type":"string","description":"The description of the `Request` (sortable: no).","example":"Example description"},"note":{"type":"string","description":"The requester's note of the `Request` (sortable: no).","example":"Requester note"},"requestTimestamp":{"type":"integer","format":"int64","description":"The epoch timestamp in millis. This is checked in Soldo. Requests with timestamp older than 5 seconds will be rejected.","example":1576850500000}},"required":["requestTimestamp","type"]},"UpdateRequestTrip":{"allOf":[{"$ref":"#/components/schemas/UpdateRequestPayload"},{"type":"object","properties":{"request_timestamp":{"type":"integer","format":"int64","description":"The epoch timestamp in millis. This is checked in Soldo. Requests with timestamp older than 5 seconds will be rejected.","example":1576850500000},"destination":{"type":"string","description":"The destination of the `Request` for the `BusinessTrip` type (sortable: no)."},"date_from":{"type":"string","description":"The start date of the `Request`  for the `BusinessTrip` type (sortable: no)."},"date_to":{"type":"string","description":"The end date of the `Request` for the `BusinessTrip` type (sortable: no)."},"expense_allocation":{"type":"array","description":"The list of `ExpenseAllocation` of the `Request` for the `BusinessTrip` type (sortable: no).","items":{"$ref":"#/components/schemas/BusinessTripExpense"}},"tags":{"type":"array","description":"The IDs of the `Tag` and related `Dictionary` of the `Request` for the `BusinessTrip` type (sortable: no)","items":{"$ref":"#/components/schemas/BusinessTripTag"}}}}],"required":["request_timestamp","type"]},"UpdateResourceSet":{"description":"Update `ResourceSet` JSON parameters.","properties":{"id":{"type":"string","description":"The `ResourceSet` ID.","example":"7bf79328-a7ae-4222-aa54-091ff7f429a7"},"name":{"type":"string","description":"The name of the `ResourceSet`.","example":"Resource set 01"},"description":{"type":"string","description":"The description of the `ResourceSet`.","example":"This is a resource set"},"configuration":{"type":"array","description":"The configuration of the `ResourceSet`.","items":{"$ref":"#/components/schemas/Configuration"}}},"required":["configuration","name"]},"UpdateSubscription":{"description":"Update `Subscription` JSON parameters.","properties":{"name":{"type":"string","description":"The name of the `Subscription`.","example":"Google Ads"},"description":{"type":"string","description":"The description of the `Subscription`.","example":"Google Ads Campaign"},"wallet_id":{"type":"string","description":"The ID of the associated `Wallet `.","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"},"payment_frequency":{"$ref":"#/components/schemas/SubscriptionPaymentFrequency","description":"The payment frequency indicates how often a `Transaction` is expected to be made.","example":"YEARLY"}}},"UpdateTagBulkItem":{"properties":{"id":{"type":"string","description":"The `Tag` ID.","example":"2d65bd5e-3fdf-4002-b166-bde7fb8863fa"},"tag":{"type":"string","description":"The name of the `Tag`.","example":"tx-label"},"description":{"type":"string","description":"The description of the `Tag`. If needed to support special characters, provide the character encoding in the `Content-Type` header (e.g. `application/x-www-form-urlencoded ; charset=utf-8`).","example":"Label to mark transactions"},"code":{"type":"string","description":"The code of the `Tag`. If needed to support special characters, provide the character encoding in the `Content-Type` header (e.g. `application/x-www-form-urlencoded ; charset=utf-8`).","example":"CODE tag","maxLength":60},"visible":{"type":"boolean","description":"It determines whether the `Tag` is visible in the `Transaction` detail.","example":true}},"required":["id","tag"]},"UpdateTagItem":{"description":"Update `Tag` bulk JSON parameters.","properties":{"tags":{"type":"array","description":"The list of the `Tag` resources to update in bulk.","example":["7bf79328-a7ae-4222-aa54-091ff7f429a7","2d65bd5e-3fdf-4002-b166-bde7fb8863fa"],"items":{"$ref":"#/components/schemas/UpdateTagBulkItem"}}}},"UpdateVatRate":{"description":"Update `VatRate` JSON parameters.","properties":{"code":{"type":"string","description":"The code of the `VATRate`.","example":"code-vat-11"},"name":{"type":"string","description":"The name of the `VATRate`.","example":"Tax 11"},"description":{"type":"string","description":"the description of the `VATRate`.","example":"something"},"percentage":{"type":"number","format":"double","description":"The percentage value of the `VATRate`.","example":15},"enabled":{"type":"boolean","description":"The `VATRate` is visible in the transaction detail.","example":true}},"required":["percentage"]},"UpdateTransaction":{"description":"Update `Transaction` JSON parameters.","properties":{"trx_owner_id":{"type":"string","description":"The `Transaction` assignee, one of the `User` ID assigned to the `Company` `Card`.","example":"XMPL1234-000001"},"user_notes":{"type":"string","description":"The `Transaction` user notes.","example":"something"},"invoice":{"$ref":"#/components/schemas/Invoice","description":"The `Invoice` related to the `Transaction`."}}},"UpdateTransactionSplit":{"description":"Update `Transaction` split JSON parameters.","properties":{"split_transactions":{"type":"array","items":{"$ref":"#/components/schemas/SplitTransaction"},"minItems":2}},"required":["split_transactions"]},"UpdateUserAccessModes":{"description":"Update `User` access JSON parameters.","properties":{"request_timestamp":{"type":"integer","format":"int64","description":"The epoch timestamp in millis. This is checked in Soldo. Requests with timestamp older than 5 seconds will be rejected.","example":1576850500000},"access_modes":{"type":"array","description":"The access modes to apply to the given `User`.","items":{"$ref":"#/components/schemas/UserAccessMode"}},"skip_credential_notification":{"type":"boolean","default":"true","description":"Avoid to notify user upon credential status change driven by `access_modes` field.","example":true}},"required":["access_modes","request_timestamp"]},"CredentialResetMode":{"type":"string","enum":["NONE","WEB","MOBILE","MOBILE_AND_WEB"]},"UpdateUserStatus":{"description":"Update `User` status JSON parameters.","properties":{"status":{"$ref":"#/components/schemas/UpdatableUserStatus","description":"The new `User` status.","example":"ACTIVE"},"credentialResetMode":{"$ref":"#/components/schemas/CredentialResetMode","default":"NONE","description":"How to reset credentials of the `User` being activated.","example":"WEB_AND_MOBILE"}},"required":["status"]},"UpdateVehicle":{"description":"Update vehicle JSON parameters.","properties":{"number_plate":{"type":"string","description":"The plate number of the `Vehicle`.","example":"AA000BB","maxLength":9},"description":{"type":"string","description":"The description of the `Vehicle`.","example":"Employee electric vehicle","maxLength":30,"pattern":"^[^<>=]{0,30}$"},"vat_deductible":{"$ref":"#/components/schemas/VatDeductibilityPercentage","description":"The VAT deductibility rate.","example":40},"fuel_type":{"$ref":"#/components/schemas/FuelType","description":"The fuel type of the `Vehicle`.","example":"PETROL"},"status":{"$ref":"#/components/schemas/VehicleStatus","description":"The status of the `Vehicle`.","example":"ACTIVE"},"reimbursement_rate":{"type":"number","description":"The rate to apply for a `MileageReimbursement`, measured in main `Wallet` currency per km.","example":0.45}}},"UpdateWallet":{"description":"The `Wallet` JSON parameters.","properties":{"name":{"type":"string","description":"The `Wallet` name.","example":"John Doe"},"label":{"type":"string","description":"The `Wallet` label.","example":"JD"},"description":{"type":"string","description":"The `Wallet` description.","example":"My company wallet"}},"required":["description","label","name"]},"UpdateWebhookSubscription":{"description":"Update `WebhookSubscription` JSON parameters.","properties":{"webhook_url":{"type":"string","description":"The URL of the `WebhookSubscription`.","example":"https://your_domain.com/xx/xx"},"enabled_events":{"type":"array","description":"The list of the `WebhookSubscription` enabled events.","example":["card_activated"],"items":{"$ref":"#/components/schemas/WebhookEventName"}},"description":{"type":"string","description":"The description of the `WebhookSubscription`.","example":"Report updates"},"active":{"type":"boolean","description":"The status of the `WebhookSubscription` (if `false`, notifications are not sent).","example":true}}},"Wallets":{"properties":{"total":{"type":"integer","format":"int32","description":"It represents the total number of available items in the list.","example":168},"pages":{"type":"integer","format":"int32","description":"It represents the total number of available pages.","example":7},"page_size":{"type":"integer","format":"int32","description":"It represents the number of items per page.","example":25},"current_page":{"type":"integer","format":"int32","description":"It indicates the current page (the counter starts from zero).","example":0},"results_size":{"type":"integer","format":"int32","description":"It indicates the size of the array results.","example":25},"results":{"type":"array","items":{"$ref":"#/components/schemas/Wallet"}}}},"WhoAmI":{"properties":{"company_name":{"type":"string","description":"The company name of the user.","example":"Example Inc."},"scopes":{"type":"array","description":"The list of the scopes granted for the API Key.","example":["ALL"],"items":{"type":"string"}}}}},"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","refreshUrl":"https://api.soldo.com/oauth/refresh","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."}}}}}},"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 order](ref:fingerprint-order) values.","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 order](ref:fingerprint-order) values.","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 order](ref:fingerprint-order) values.","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"}}},"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 order](ref:fingerprint-order) values.","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 order](ref:fingerprint-order) values.","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 order](ref:fingerprint-order) values.","example":"{{fingerprint}}"}},{"name":"X-Soldo-Fingerprint-Order","in":"header","required":true,"schema":{"type":"string","default":"startDate, policyUrl, enabled, transactionId","description":"[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.","example":"startDate, policyUrl, enabled, transactionId"}},{"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/CreatedExpenseConfigurationEvent"}}}},"responses":{"200":{"description":"Success."}},"x-soldo":{"fingerprint-order":"startDate, policyUrl, enabled, transactionId"}}},"change_expense_type":{"post":{"tags":["Webhooks","Expense Reviews"],"summary":"Expense Review - Change Expense Type","description":"A `Transaction` expense type has been changed.","operationId":"webhook-expensereview-change-expense-type","parameters":[{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","example":"{{fingerprint}}"}},{"name":"X-Soldo-Fingerprint-Order","in":"header","required":true,"schema":{"type":"string","default":"startDate, policyUrl, enabled, transactionId","description":"[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.","example":"startDate, policyUrl, enabled, transactionId"}},{"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/ChangeExpenseTypeEvent"}}}},"responses":{"200":{"description":"Success."}},"x-soldo":{"fingerprint-order":"startDate, policyUrl, enabled, transactionId"}}},"move_resources_member":{"post":{"tags":["Webhooks","Groups"],"summary":"Group - Move Resources Member","description":"An `User` is moved to another `Group`.","operationId":"webhook-group-move-resources-member","parameters":[{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","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/MoveResourcesMemberEvent"}}}},"responses":{"200":{"description":"Success."}},"x-soldo":{"fingerprint-order":"id, name, type, customReferenceId"}}},"purchase_redeem_card":{"post":{"tags":["Webhooks","Pre-approved Spend"],"summary":"Pre-Approved Spend - Purchase Redeem Card","description":"A `Card` of purchase has been redeemed.","operationId":"webhook-preapprovedspend-purchase-redeem-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 order](ref:fingerprint-order) values.","example":"{{fingerprint}}"}},{"name":"X-Soldo-Fingerprint-Order","in":"header","required":true,"schema":{"type":"string","default":"id, title, description, amount, amountCurrency","description":"[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.","example":"id, title, description, amount, amountCurrency"}},{"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/PurchaseRedeemCardEvent"}}}},"responses":{"200":{"description":"Success."}},"x-soldo":{"fingerprint-order":"id, title, description, amount, amountCurrency"}}},"billing":{"post":{"tags":["Webhooks","Transactions"],"summary":"Transaction - Billing","description":"Billing related to `Card` purchase.","operationId":"webhook-transaction-billing","parameters":[{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","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/BillingEvent"}}}},"responses":{"200":{"description":"Success."}},"x-soldo":{"fingerprint-order":"id, walletId, status, transactionSign"}}},"customer_care_deposit":{"post":{"tags":["Webhooks","Transactions"],"summary":"Transaction - Customer Care Deposit","description":"A `Deposit` has been performed by customer care support.","operationId":"webhook-transaction-customer-care-deposit","parameters":[{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","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/CustomerCareDepositEvent"}}}},"responses":{"200":{"description":"Success."}},"x-soldo":{"fingerprint-order":"id, walletId, status, transactionSign"}}},"store_order_completed":{"post":{"tags":["Webhooks","Orders"],"summary":"Order - Store Order Completed","description":"An `Order` has been completed.","operationId":"webhook-order-store-order-completed","parameters":[{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","example":"{{fingerprint}}"}},{"name":"X-Soldo-Fingerprint-Order","in":"header","required":true,"schema":{"type":"string","default":"id, status","description":"[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.","example":"id, status"}},{"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/StoreOrderCompletedEvent"}}}},"responses":{"200":{"description":"Success."}},"x-soldo":{"fingerprint-order":"id, status"}}},"card_lost":{"post":{"tags":["Webhooks","Cards"],"summary":"Card - Card Lost","description":"A `Card` has been reported as lost.","operationId":"webhook-card-card-lost","parameters":[{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","example":"{{fingerprint}}"}},{"name":"X-Soldo-Fingerprint-Order","in":"header","required":true,"schema":{"type":"string","default":"id, name, status, walletId","description":"[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.","example":"id, name, status, walletId"}},{"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/CardLostEvent"}}}},"responses":{"200":{"description":"Success."}},"x-soldo":{"fingerprint-order":"id, name, status, walletId"}}},"inbound_payment_reversal":{"post":{"tags":["Webhooks","Transactions"],"summary":"Transaction - Inbound Payment Reversal","description":"Reversal of an inbound payment from Faster Payment","operationId":"webhook-transaction-inbound-payment-reversal","parameters":[{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","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/InboundPaymentReversalEvent"}}}},"responses":{"200":{"description":"Success."}},"x-soldo":{"fingerprint-order":"id, walletId, status, transactionSign"}}},"new_user":{"post":{"tags":["Webhooks","Users"],"summary":"User - New User","description":"A new `User` has been created.","operationId":"webhook-user-new-user","parameters":[{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","example":"{{fingerprint}}"}},{"name":"X-Soldo-Fingerprint-Order","in":"header","required":true,"schema":{"type":"string","default":"id, name, surname, status","description":"[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.","example":"id, name, surname, status"}},{"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/NewUserEvent"}}}},"responses":{"200":{"description":"Success."}},"x-soldo":{"fingerprint-order":"id, name, surname, status"}}},"updated_expense_configuration":{"post":{"tags":["Webhooks","Expense Review Configuration"],"summary":"Expense Review - Updated Expense Configuration","description":"An `ExpenseReview` configuration is updated.","operationId":"webhook-expensereview-updated-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 order](ref:fingerprint-order) values.","example":"{{fingerprint}}"}},{"name":"X-Soldo-Fingerprint-Order","in":"header","required":true,"schema":{"type":"string","default":"startDate, policyUrl, enabled, transactionId","description":"[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.","example":"startDate, policyUrl, enabled, transactionId"}},{"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/UpdatedExpenseConfigurationEvent"}}}},"responses":{"200":{"description":"Success."}},"x-soldo":{"fingerprint-order":"startDate, policyUrl, enabled, transactionId"}}},"scheduled_transfer":{"post":{"tags":["Webhooks","Transactions"],"summary":"Transaction - Scheduled Transfer","description":"Failed scheduled internal transfer to top-up a `Wallet`.","operationId":"webhook-transaction-scheduled-transfer","parameters":[{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","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/ScheduledTransferEvent"}}}},"responses":{"200":{"description":"Success."}},"x-soldo":{"fingerprint-order":"id, walletId, status, transactionSign"}}},"transaction_modified":{"post":{"tags":["Webhooks","Transactions"],"summary":"Transaction - Transaction Modified","description":"A `Transaction` has been modified, e.g. moved to another `Wallet` or changed in other describing attributes.","operationId":"webhook-transaction-transaction-modified","parameters":[{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","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/TransactionModifiedEvent"}}}},"responses":{"200":{"description":"Success."}},"x-soldo":{"fingerprint-order":"id, walletId, status, transactionSign"}}},"card_change_status":{"post":{"tags":["Webhooks","Cards"],"summary":"Card - Card Change Status","description":"A `Card` changed status.","operationId":"webhook-card-card-change_status","parameters":[{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","example":"{{fingerprint}}"}},{"name":"X-Soldo-Fingerprint-Order","in":"header","required":true,"schema":{"type":"string","default":"id, name, status, walletId","description":"[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.","example":"id, name, status, walletId"}},{"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/CardChangeStatusEvent"}}}},"responses":{"200":{"description":"Success."}},"x-soldo":{"fingerprint-order":"id, name, status, walletId"}}},"online_ads_updated":{"post":{"tags":["Webhooks","Online Ads"],"summary":"OnlineAds - OnlineAds Updated","description":"An `OnlineAds` has been updated.","operationId":"webhook-onlineads-online-ads-updated","parameters":[{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","example":"{{fingerprint}}"}},{"name":"X-Soldo-Fingerprint-Order","in":"header","required":true,"schema":{"type":"string","default":"id, name, walletId, cardId","description":"[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.","example":"id, name, walletId, cardId"}},{"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/OnlineAdsUpdatedEvent"}}}},"responses":{"200":{"description":"Success."}},"x-soldo":{"fingerprint-order":"id, name, walletId, cardId"}}},"delete_group":{"post":{"tags":["Webhooks","Groups"],"summary":"Group - Group Deleted","description":"A`Group` has been deleted.","operationId":"webhook-group-delete-group","parameters":[{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","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/DeleteGroupEvent"}}}},"responses":{"200":{"description":"Success."}},"x-soldo":{"fingerprint-order":"id, name, type, customReferenceId"}}},"load_money":{"post":{"tags":["Webhooks","Transactions"],"summary":"Transaction - Load Money","description":"A money load on company `Wallet` succeeded.","operationId":"webhook-transaction-load-money","parameters":[{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","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/LoadMoneyEvent"}}}},"responses":{"200":{"description":"Success."}},"x-soldo":{"fingerprint-order":"id, walletId, status, transactionSign"}}},"wiretransfer":{"post":{"tags":["Webhooks","Transactions"],"summary":"Transaction - Wiretransfer","description":"Deposit in.","operationId":"webhook-transaction-wiretransfer","parameters":[{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","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/WiretransferEvent"}}}},"responses":{"200":{"description":"Success."}},"x-soldo":{"fingerprint-order":"id, walletId, status, transactionSign"}}},"card_destroyed":{"post":{"tags":["Webhooks","Cards"],"summary":"Card - Card Destroyed","description":"A `Card` has been destroyed.","operationId":"webhook-card-card-destroyed","parameters":[{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","example":"{{fingerprint}}"}},{"name":"X-Soldo-Fingerprint-Order","in":"header","required":true,"schema":{"type":"string","default":"id, name, status, walletId","description":"[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.","example":"id, name, status, walletId"}},{"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/CardDestroyedEvent"}}}},"responses":{"200":{"description":"Success."}},"x-soldo":{"fingerprint-order":"id, name, status, walletId"}}},"card_authorization":{"post":{"tags":["Webhooks","Transactions"],"summary":"Transaction - Card Authorization","description":"A `Transaction` authorisation has been requested.","operationId":"webhook-transaction-card-authorization","parameters":[{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","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/CardAuthorizationEvent"}}}},"responses":{"200":{"description":"Success."}},"x-soldo":{"fingerprint-order":"id, walletId, status, transactionSign"}}},"updated_transaction":{"post":{"tags":["Webhooks","Expense Reviews"],"summary":"Expense Review - Updated Transaction","description":"A `Transaction` has been update.","operationId":"webhook-expensereview-updated-transaction","parameters":[{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","example":"{{fingerprint}}"}},{"name":"X-Soldo-Fingerprint-Order","in":"header","required":true,"schema":{"type":"string","default":"startDate, policyUrl, enabled, transactionId","description":"[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.","example":"startDate, policyUrl, enabled, transactionId"}},{"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/UpdatedTransactionEvent"}}}},"responses":{"200":{"description":"Success."}},"x-soldo":{"fingerprint-order":"startDate, policyUrl, enabled, transactionId"}}},"transaction_adjustment":{"post":{"tags":["Webhooks","Transactions"],"summary":"Transaction - Transaction Adjustment","description":"A `Transaction` has been adjusted.","operationId":"webhook-transaction-transaction-adjustment","parameters":[{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","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/TransactionAdjustmentEvent"}}}},"responses":{"200":{"description":"Success."}},"x-soldo":{"fingerprint-order":"id, walletId, status, transactionSign"}}},"attachment_delete":{"post":{"tags":["Webhooks","Transaction Attachments"],"summary":"Transaction Attachment - Attachment Delete","description":"An attachment has been deleted from a `Transaction`.","operationId":"webhook-transactionattachment-attachment-delete","parameters":[{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","example":"{{fingerprint}}"}},{"name":"X-Soldo-Fingerprint-Order","in":"header","required":true,"schema":{"type":"string","default":"attachmentId, transactionId, fileName","description":"[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.","example":"attachmentId, transactionId, fileName"}},{"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/AttachmentDeleteEvent"}}}},"responses":{"200":{"description":"Success."}},"x-soldo":{"fingerprint-order":"attachmentId, transactionId, fileName"}}},"disabled_expense_configuration":{"post":{"tags":["Webhooks","Expense Review Configuration"],"summary":"Expense Review - Configuration Disabled","description":"An `ExpenseReview` configuration has been disabled.","operationId":"webhook-expensereview-disabled-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 order](ref:fingerprint-order) values.","example":"{{fingerprint}}"}},{"name":"X-Soldo-Fingerprint-Order","in":"header","required":true,"schema":{"type":"string","default":"startDate, policyUrl, enabled, transactionId","description":"[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.","example":"startDate, policyUrl, enabled, transactionId"}},{"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/DisabledExpenseConfigurationEvent"}}}},"responses":{"200":{"description":"Success."}},"x-soldo":{"fingerprint-order":"startDate, policyUrl, enabled, transactionId"}}},"purchase_delete":{"post":{"tags":["Webhooks","Pre-approved Spend"],"summary":"Pre-Approved Spend - Purchase Delete","description":"A `Purchase` has been deleted.","operationId":"webhook-preapprovedspend-purchase-delete","parameters":[{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","example":"{{fingerprint}}"}},{"name":"X-Soldo-Fingerprint-Order","in":"header","required":true,"schema":{"type":"string","default":"id, title, description, amount, amountCurrency","description":"[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.","example":"id, title, description, amount, amountCurrency"}},{"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/PurchaseDeleteEvent"}}}},"responses":{"200":{"description":"Success."}},"x-soldo":{"fingerprint-order":"id, title, description, amount, amountCurrency"}}},"wallet_created":{"post":{"tags":["Webhooks","Wallets"],"summary":"Wallet - Wallet Created","description":"A new `Wallet` has been created.","operationId":"webhook-wallet-wallet-created","parameters":[{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","example":"{{fingerprint}}"}},{"name":"X-Soldo-Fingerprint-Order","in":"header","required":true,"schema":{"type":"string","default":"id, name, currencyCode, primaryUserPublicId","description":"[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.","example":"id, name, currencyCode, primaryUserPublicId"}},{"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/WalletCreatedEvent"}}}},"responses":{"200":{"description":"Success."}},"x-soldo":{"fingerprint-order":"id, name, currencyCode, primaryUserPublicId"}}},"card_activated":{"post":{"tags":["Webhooks","Cards"],"summary":"Card - Card Activated","description":"A `Card` has been activated.","operationId":"webhook-card-card-activated","parameters":[{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","example":"{{fingerprint}}"}},{"name":"X-Soldo-Fingerprint-Order","in":"header","required":true,"schema":{"type":"string","default":"id, name, status, walletId","description":"[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.","example":"id, name, status, walletId"}},{"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/CardActivatedEvent"}}}},"responses":{"200":{"description":"Success."}},"x-soldo":{"fingerprint-order":"id, name, status, walletId"}}},"unload_money":{"post":{"tags":["Webhooks","Transactions"],"summary":"Transaction - Unload Money","description":"Unload money from a company `Wallet`.","operationId":"webhook-transaction-unload-money","parameters":[{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","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/UnloadMoneyEvent"}}}},"responses":{"200":{"description":"Success."}},"x-soldo":{"fingerprint-order":"id, walletId, status, transactionSign"}}},"create_group":{"post":{"tags":["Webhooks","Groups"],"summary":"Group - Group Created","description":"A new `Group` has been created.","operationId":"webhook-group-create-group","parameters":[{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","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/CreateGroupEvent"}}}},"responses":{"200":{"description":"Success."}},"x-soldo":{"fingerprint-order":"id, name, type, customReferenceId"}}},"update_group":{"post":{"tags":["Webhooks","Groups"],"summary":"Group - Update Group","description":"A `Group` has been updated.","operationId":"webhook-group-update-group","parameters":[{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","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/UpdateGroupEvent"}}}},"responses":{"200":{"description":"Success."}},"x-soldo":{"fingerprint-order":"id, name, type, customReferenceId"}}},"user_updated":{"post":{"tags":["Webhooks","Users"],"summary":"User - User Updated","description":"An `User` has been updated.","operationId":"webhook-user-user-updated","parameters":[{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","example":"{{fingerprint}}"}},{"name":"X-Soldo-Fingerprint-Order","in":"header","required":true,"schema":{"type":"string","default":"id, name, surname, status","description":"[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.","example":"id, name, surname, status"}},{"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/UserUpdatedEvent"}}}},"responses":{"200":{"description":"Success."}},"x-soldo":{"fingerprint-order":"id, name, surname, status"}}},"subscription_assignee_added":{"post":{"tags":["Webhooks","Subscriptions"],"summary":"Subscription - Subscription Assignee Added","description":"A `Subscription` assignee is added.","operationId":"webhook-subscription-subscription-assignee-added","parameters":[{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","example":"{{fingerprint}}"}},{"name":"X-Soldo-Fingerprint-Order","in":"header","required":true,"schema":{"type":"string","default":"id, name, platform, status, paymentFrequency, cardId","description":"[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.","example":"id, name, platform, status, paymentFrequency, cardId"}},{"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/SubscriptionAssigneeAddedEvent"}}}},"responses":{"200":{"description":"Success."}},"x-soldo":{"fingerprint-order":"id, name, platform, status, paymentFrequency, cardId"}}},"inbound_payment":{"post":{"tags":["Webhooks","Transactions"],"summary":"Transaction - Inbound Payment","description":"Inbound payment from Faster Payment","operationId":"webhook-transaction-inbound-payment","parameters":[{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","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/InboundPaymentEvent"}}}},"responses":{"200":{"description":"Success."}},"x-soldo":{"fingerprint-order":"id, walletId, status, transactionSign"}}},"joule_feed":{"post":{"tags":["Webhooks","Transactions"],"summary":"Transaction - Joule Feed","description":"A `Transaction` has been settled/reversed.","operationId":"webhook-transaction-joule-feed","parameters":[{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","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/JouleFeedEvent"}}}},"responses":{"200":{"description":"Success."}},"x-soldo":{"fingerprint-order":"id, walletId, status, transactionSign"}}},"vehicle_create":{"post":{"tags":["Webhooks","Vehicles"],"summary":"Vehicle - Vehicle Create","description":"A `Vehicle` has been created.","operationId":"webhook-vehicle-vehicle-create","parameters":[{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","example":"{{fingerprint}}"}},{"name":"X-Soldo-Fingerprint-Order","in":"header","required":true,"schema":{"type":"string","default":"id,numberPlate","description":"[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.","example":"id,numberPlate"}},{"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/VehicleCreateEvent"}}}},"responses":{"200":{"description":"Success."}},"x-soldo":{"fingerprint-order":"id,numberPlate"}}},"card_replaced":{"post":{"tags":["Webhooks","Cards"],"summary":"Card - Card Replaced","description":"A `Card` has been replaced.","operationId":"webhook-card-card-replaced","parameters":[{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","example":"{{fingerprint}}"}},{"name":"X-Soldo-Fingerprint-Order","in":"header","required":true,"schema":{"type":"string","default":"id, name, status, walletId","description":"[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.","example":"id, name, status, walletId"}},{"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/CardReplacedEvent"}}}},"responses":{"200":{"description":"Success."}},"x-soldo":{"fingerprint-order":"id, name, status, walletId"}}},"card_stolen":{"post":{"tags":["Webhooks","Cards"],"summary":"Card - Card Stolen","description":"A `Card` has been reported as stolen.","operationId":"webhook-card-card-stolen","parameters":[{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","example":"{{fingerprint}}"}},{"name":"X-Soldo-Fingerprint-Order","in":"header","required":true,"schema":{"type":"string","default":"id, name, status, walletId","description":"[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.","example":"id, name, status, walletId"}},{"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/CardStolenEvent"}}}},"responses":{"200":{"description":"Success."}},"x-soldo":{"fingerprint-order":"id, name, status, walletId"}}},"card_creation":{"post":{"tags":["Webhooks","Cards"],"summary":"Card - Card Creation","description":"A new `Card` has been created.","operationId":"webhook-card-card-creation","parameters":[{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","example":"{{fingerprint}}"}},{"name":"X-Soldo-Fingerprint-Order","in":"header","required":true,"schema":{"type":"string","default":"id, name, status, walletId","description":"[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.","example":"id, name, status, walletId"}},{"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/CardCreationEvent"}}}},"responses":{"200":{"description":"Success."}},"x-soldo":{"fingerprint-order":"id, name, status, walletId"}}},"add_resources_card":{"post":{"tags":["Webhooks","Groups"],"summary":"Group - Add Resources Card","description":"A `Card` has been added to a `Group`.","operationId":"webhook-group-add-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 order](ref:fingerprint-order) values.","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/AddResourcesCardEvent"}}}},"responses":{"200":{"description":"Success."}},"x-soldo":{"fingerprint-order":"id, name, type, customReferenceId"}}},"online_ads_created":{"post":{"tags":["Webhooks","Online Ads"],"summary":"OnlineAds - OnlineAds Created","description":"An `OnlineAds` has been created.","operationId":"webhook-onlineads-online-ads-created","parameters":[{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","example":"{{fingerprint}}"}},{"name":"X-Soldo-Fingerprint-Order","in":"header","required":true,"schema":{"type":"string","default":"id, name, walletId, cardId","description":"[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.","example":"id, name, walletId, cardId"}},{"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/OnlineAdsCreatedEvent"}}}},"responses":{"200":{"description":"Success."}},"x-soldo":{"fingerprint-order":"id, name, walletId, cardId"}}},"vehicle_delete":{"post":{"tags":["Webhooks","Vehicles"],"summary":"Vehicle - Vehicle Delete","description":"A `Vehicle` has been deleted.","operationId":"webhook-vehicle-vehicle-delete","parameters":[{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","example":"{{fingerprint}}"}},{"name":"X-Soldo-Fingerprint-Order","in":"header","required":true,"schema":{"type":"string","default":"id,numberPlate","description":"[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.","example":"id,numberPlate"}},{"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/VehicleDeleteEvent"}}}},"responses":{"200":{"description":"Success."}},"x-soldo":{"fingerprint-order":"id,numberPlate"}}},"remove_resources_member":{"post":{"tags":["Webhooks","Groups"],"summary":"Group - Remove Resources Member","description":"An `User` has been removed from a `Group`.","operationId":"webhook-group-remove-resources-member","parameters":[{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","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/RemoveResourcesMemberEvent"}}}},"responses":{"200":{"description":"Success."}},"x-soldo":{"fingerprint-order":"id, name, type, customReferenceId"}}},"subscription_created":{"post":{"tags":["Webhooks","Subscriptions"],"summary":"Subscription - Subscription Created","description":"A `Subscription` has been created.","operationId":"webhook-subscription-subscription-created","parameters":[{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","example":"{{fingerprint}}"}},{"name":"X-Soldo-Fingerprint-Order","in":"header","required":true,"schema":{"type":"string","default":"id, name, platform, status, paymentFrequency, cardId","description":"[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.","example":"id, name, platform, status, paymentFrequency, cardId"}},{"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/SubscriptionCreatedEvent"}}}},"responses":{"200":{"description":"Success."}},"x-soldo":{"fingerprint-order":"id, name, platform, status, paymentFrequency, cardId"}}},"add_resources_wallet":{"post":{"tags":["Webhooks","Groups"],"summary":"Group - Add Resources Wallet","description":"A `Wallet` has been added to a `Group`.","operationId":"webhook-group-add-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 order](ref:fingerprint-order) values.","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/AddResourcesWalletEvent"}}}},"responses":{"200":{"description":"Success."}},"x-soldo":{"fingerprint-order":"id, name, type, customReferenceId"}}},"balanced_transfer":{"post":{"tags":["Webhooks","Transactions"],"summary":"Transaction - Balanced Transfer","description":"Failed balanced internal transfer to top-up a `Wallet`.","operationId":"webhook-transaction-balanced-transfer","parameters":[{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","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/BalancedTransferEvent"}}}},"responses":{"200":{"description":"Success."}},"x-soldo":{"fingerprint-order":"id, walletId, status, transactionSign"}}},"vehicle_update":{"post":{"tags":["Webhooks","Vehicles"],"summary":"Vehicle - Vehicle Update","description":"A `Vehicle` has been updated.","operationId":"webhook-vehicle-vehicle-update","parameters":[{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","example":"{{fingerprint}}"}},{"name":"X-Soldo-Fingerprint-Order","in":"header","required":true,"schema":{"type":"string","default":"id,numberPlate","description":"[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.","example":"id,numberPlate"}},{"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/VehicleUpdateEvent"}}}},"responses":{"200":{"description":"Success."}},"x-soldo":{"fingerprint-order":"id,numberPlate"}}},"online_ads_activated":{"post":{"tags":["Webhooks","Online Ads"],"summary":"OnlineAds - OnlineAds Activated","description":"An `OnlineAds` has been activated.","operationId":"webhook-onlineads-online-ads-activated","parameters":[{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","example":"{{fingerprint}}"}},{"name":"X-Soldo-Fingerprint-Order","in":"header","required":true,"schema":{"type":"string","default":"id, name, walletId, cardId","description":"[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.","example":"id, name, walletId, cardId"}},{"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/OnlineAdsActivatedEvent"}}}},"responses":{"200":{"description":"Success."}},"x-soldo":{"fingerprint-order":"id, name, walletId, cardId"}}},"card_label_updated":{"post":{"tags":["Webhooks","Cards"],"summary":"Card - Card Update Label","description":"A label `Card` has been updated label.","operationId":"webhook-card-card_label_updated","parameters":[{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","example":"{{fingerprint}}"}},{"name":"X-Soldo-Fingerprint-Order","in":"header","required":true,"schema":{"type":"string","default":"id,label,token","description":"[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.","example":"id, name, status, walletId"}},{"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/CardLabelUpdatedEvent"}}}},"responses":{"200":{"description":"Success."}},"x-soldo":{"fingerprint-order":"id, name, status, walletId"}}},"subscription_deleted":{"post":{"tags":["Webhooks","Subscriptions"],"summary":"Subscription - Subscription Deleted","description":"A `Subscription` has been deleted.","operationId":"webhook-subscription-subscription-deleted","parameters":[{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","example":"{{fingerprint}}"}},{"name":"X-Soldo-Fingerprint-Order","in":"header","required":true,"schema":{"type":"string","default":"id, name, platform, status, paymentFrequency, cardId","description":"[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.","example":"id, name, platform, status, paymentFrequency, cardId"}},{"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/SubscriptionDeletedEvent"}}}},"responses":{"200":{"description":"Success."}},"x-soldo":{"fingerprint-order":"id, name, platform, status, paymentFrequency, cardId"}}},"recurring_billing":{"post":{"tags":["Webhooks","Transactions"],"summary":"Transaction - Recurring Billing","description":"Monthly billing.","operationId":"webhook-transaction-recurring-billing","parameters":[{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","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/RecurringBillingEvent"}}}},"responses":{"200":{"description":"Success."}},"x-soldo":{"fingerprint-order":"id, walletId, status, transactionSign"}}},"upload_completed":{"post":{"tags":["Webhooks","Transaction Attachments"],"summary":"Transaction Attachment - Upload Completed","description":"An attachment is uploaded to a `Transaction`.","operationId":"webhook-transactionattachment-upload-completed","parameters":[{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","example":"{{fingerprint}}"}},{"name":"X-Soldo-Fingerprint-Order","in":"header","required":true,"schema":{"type":"string","default":"attachmentId, transactionId, fileName","description":"[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.","example":"attachmentId, transactionId, fileName"}},{"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/UploadCompletedEvent"}}}},"responses":{"200":{"description":"Success."}},"x-soldo":{"fingerprint-order":"attachmentId, transactionId, fileName"}}},"subscription_updated":{"post":{"tags":["Webhooks","Subscriptions"],"summary":"Subscription - Subscription Updated","description":"A `Subscription` has been updated.","operationId":"webhook-subscription-subscription-updated","parameters":[{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","example":"{{fingerprint}}"}},{"name":"X-Soldo-Fingerprint-Order","in":"header","required":true,"schema":{"type":"string","default":"id, name, platform, status, paymentFrequency, cardId","description":"[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.","example":"id, name, platform, status, paymentFrequency, cardId"}},{"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/SubscriptionUpdatedEvent"}}}},"responses":{"200":{"description":"Success."}},"x-soldo":{"fingerprint-order":"id, name, platform, status, paymentFrequency, cardId"}}},"online_ads_deleted":{"post":{"tags":["Webhooks","Online Ads"],"summary":"OnlineAds - OnlineAds Deleted","description":"An `OnlineAds` has been deleted.","operationId":"webhook-onlineads-online-ads-deleted","parameters":[{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","example":"{{fingerprint}}"}},{"name":"X-Soldo-Fingerprint-Order","in":"header","required":true,"schema":{"type":"string","default":"id, name, walletId, cardId","description":"[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.","example":"id, name, walletId, cardId"}},{"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/OnlineAdsDeletedEvent"}}}},"responses":{"200":{"description":"Success."}},"x-soldo":{"fingerprint-order":"id, name, walletId, cardId"}}},"conversion":{"post":{"tags":["Webhooks","Transactions"],"summary":"Transaction - Conversion","description":"A transfer between `Wallets` with different currencies.","operationId":"webhook-transaction-conversion","parameters":[{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","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/ConversionEvent"}}}},"responses":{"200":{"description":"Success."}},"x-soldo":{"fingerprint-order":"id, walletId, status, transactionSign"}}},"edit_tag":{"post":{"tags":["Webhooks","Transactions"],"summary":"Transaction - Tag Edited","description":"A `Tag` has been added or removed from a `Transaction`.","operationId":"webhook-transaction-edit-tag","parameters":[{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","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/EditTagEvent"}}}},"responses":{"200":{"description":"Success."}},"x-soldo":{"fingerprint-order":"id, walletId, status, transactionSign"}}},"online_ads_assignee_added":{"post":{"tags":["Webhooks","Online Ads"],"summary":"OnlineAds - OnlineAds Assignee Added","description":"An `OnlineAds` assignee has been added.","operationId":"webhook-onlineads-online-ads-assignee-added","parameters":[{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","example":"{{fingerprint}}"}},{"name":"X-Soldo-Fingerprint-Order","in":"header","required":true,"schema":{"type":"string","default":"id, name, walletId, cardId","description":"[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.","example":"id, name, walletId, cardId"}},{"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/OnlineAdsAssigneeAddedEvent"}}}},"responses":{"200":{"description":"Success."}},"x-soldo":{"fingerprint-order":"id, name, walletId, cardId"}}},"purchase_update":{"post":{"tags":["Webhooks","Pre-approved Spend"],"summary":"Pre-Approved Spend - Purchase Update","description":"A `Purchase` has been updated.","operationId":"webhook-preapprovedspend-purchase-update","parameters":[{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","example":"{{fingerprint}}"}},{"name":"X-Soldo-Fingerprint-Order","in":"header","required":true,"schema":{"type":"string","default":"id, title, description, amount, amountCurrency","description":"[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.","example":"id, title, description, amount, amountCurrency"}},{"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/PurchaseUpdateEvent"}}}},"responses":{"200":{"description":"Success."}},"x-soldo":{"fingerprint-order":"id, title, description, amount, amountCurrency"}}},"online_ads_assignee_removed":{"post":{"tags":["Webhooks","Online Ads"],"summary":"OnlineAds - OnlineAds Assignee Removed","description":"An `OnlineAds` assignee has been removed.","operationId":"webhook-onlineads-online-ads-assignee-removed","parameters":[{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","example":"{{fingerprint}}"}},{"name":"X-Soldo-Fingerprint-Order","in":"header","required":true,"schema":{"type":"string","default":"id, name, walletId, cardId","description":"[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.","example":"id, name, walletId, cardId"}},{"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/OnlineAdsAssigneeRemovedEvent"}}}},"responses":{"200":{"description":"Success."}},"x-soldo":{"fingerprint-order":"id, name, walletId, cardId"}}},"wallet_deleted":{"post":{"tags":["Webhooks","Wallets"],"summary":"Wallet - Wallet Deleted","description":"A `Wallet` has been deleted.","operationId":"webhook-wallet-wallet-deleted","parameters":[{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","example":"{{fingerprint}}"}},{"name":"X-Soldo-Fingerprint-Order","in":"header","required":true,"schema":{"type":"string","default":"id, name, currencyCode, primaryUserPublicId","description":"[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.","example":"id, name, currencyCode, primaryUserPublicId"}},{"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/WalletDeletedEvent"}}}},"responses":{"200":{"description":"Success."}},"x-soldo":{"fingerprint-order":"id, name, currencyCode, primaryUserPublicId"}}},"remove_resources_wallet":{"post":{"tags":["Webhooks","Groups"],"summary":"Group - Remove Resources Wallet","description":"A `Wallet` is removed from a `Group`.","operationId":"webhook-group-remove-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 order](ref:fingerprint-order) values.","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/RemoveResourcesWalletEvent"}}}},"responses":{"200":{"description":"Success."}},"x-soldo":{"fingerprint-order":"id, name, type, customReferenceId"}}},"enabled_expense_configuration":{"post":{"tags":["Webhooks","Expense Review Configuration"],"summary":"Expense Review - Configuration Enabled","description":"An `ExpenseReview` configuration has been enabled.","operationId":"webhook-expensereview-enabled-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 order](ref:fingerprint-order) values.","example":"{{fingerprint}}"}},{"name":"X-Soldo-Fingerprint-Order","in":"header","required":true,"schema":{"type":"string","default":"startDate, policyUrl, enabled, transactionId","description":"[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.","example":"startDate, policyUrl, enabled, transactionId"}},{"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/EnabledExpenseConfigurationEvent"}}}},"responses":{"200":{"description":"Success."}},"x-soldo":{"fingerprint-order":"startDate, policyUrl, enabled, transactionId"}}},"completed_transactions_import":{"post":{"tags":["Webhooks","Expense Reviews"],"summary":"Expense Review - Transaction Import Completed","description":"A `Transaction` import has been completed.","operationId":"webhook-expensereview-completed-transactions-import","parameters":[{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","example":"{{fingerprint}}"}},{"name":"X-Soldo-Fingerprint-Order","in":"header","required":true,"schema":{"type":"string","default":"startDate, policyUrl, enabled, transactionId","description":"[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.","example":"startDate, policyUrl, enabled, transactionId"}},{"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/CompletedTransactionsImportEvent"}}}},"responses":{"200":{"description":"Success."}},"x-soldo":{"fingerprint-order":"startDate, policyUrl, enabled, transactionId"}}},"store_order_placed":{"post":{"tags":["Webhooks","Orders"],"summary":"Order - Store Order Placed","description":"An `Order` has been placed.","operationId":"webhook-order-store-order-placed","parameters":[{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","example":"{{fingerprint}}"}},{"name":"X-Soldo-Fingerprint-Order","in":"header","required":true,"schema":{"type":"string","default":"id, status","description":"[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.","example":"id, status"}},{"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/StoreOrderPlacedEvent"}}}},"responses":{"200":{"description":"Success."}},"x-soldo":{"fingerprint-order":"id, status"}}},"purchase_create":{"post":{"tags":["Webhooks","Pre-approved Spend"],"summary":"Pre-Approved Spend - Purchase Create","description":"A `Purchase` has been created.","operationId":"webhook-preapprovedspend-purchase-create","parameters":[{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","example":"{{fingerprint}}"}},{"name":"X-Soldo-Fingerprint-Order","in":"header","required":true,"schema":{"type":"string","default":"id, title, description, amount, amountCurrency","description":"[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.","example":"id, title, description, amount, amountCurrency"}},{"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/PurchaseCreateEvent"}}}},"responses":{"200":{"description":"Success."}},"x-soldo":{"fingerprint-order":"id, title, description, amount, amountCurrency"}}},"subscription_assignee_removed":{"post":{"tags":["Webhooks"],"summary":"Subscription - Subscription Assignee Removed","description":"A `Subscription` assignee is removed.","operationId":"webhook-subscription-subscription-assignee-removed","parameters":[{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","example":"{{fingerprint}}"}},{"name":"X-Soldo-Fingerprint-Order","in":"header","required":true,"schema":{"type":"string","default":"id, name, platform, status, paymentFrequency, cardId","description":"[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.","example":"id, name, platform, status, paymentFrequency, cardId"}},{"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/SubscriptionAssigneeRemovedEvent"}}}},"responses":{"200":{"description":"Success."}},"x-soldo":{"fingerprint-order":"id, name, platform, status, paymentFrequency, cardId"}}},"add_resources_member":{"post":{"tags":["Webhooks","Groups"],"summary":"Group - Add Resources Member","description":"An `User` has been added to a `Group`.","operationId":"webhook-group-add-resources-member","parameters":[{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","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/AddResourcesMemberEvent"}}}},"responses":{"200":{"description":"Success."}},"x-soldo":{"fingerprint-order":"id, name, type, customReferenceId"}}},"internal_transfer":{"post":{"tags":["Webhooks","Transactions"],"summary":"Transaction - Internal Transfer","description":"A Transfer between `Wallets` with the same currency","operationId":"webhook-transaction-internal-transfer","parameters":[{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","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/InternalTransferEvent"}}}},"responses":{"200":{"description":"Success."}},"x-soldo":{"fingerprint-order":"id, walletId, status, transactionSign"}}},"card_assignee_updated":{"post":{"tags":["Webhooks","Cards"],"summary":"Card - Card Update Assignee","description":"A label `Card` has been updated assignee.","operationId":"webhook-card-card_assignee_updated","parameters":[{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","example":"{{fingerprint}}"}},{"name":"X-Soldo-Fingerprint-Order","in":"header","required":true,"schema":{"type":"string","default":"id,join(addCardAssignees),join(removeCardAssignees),token","description":"[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.","example":"id, name, status, walletId"}},{"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/CardAssigneeUpdatedEvent"}}}},"responses":{"200":{"description":"Success."}},"x-soldo":{"fingerprint-order":"id, name, status, walletId"}}},"user_status_changed":{"post":{"tags":["Webhooks","Users"],"summary":"User - User Status Changed","description":"The status of a `User` changed.","operationId":"webhook-user-user-status-changed","parameters":[{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","example":"{{fingerprint}}"}},{"name":"X-Soldo-Fingerprint-Order","in":"header","required":true,"schema":{"type":"string","default":"id, name, surname, status","description":"[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.","example":"id, name, surname, status"}},{"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/UserStatusChangedEvent"}}}},"responses":{"200":{"description":"Success."}},"x-soldo":{"fingerprint-order":"id, name, surname, status"}}},"subscription_activated":{"post":{"tags":["Webhooks","Subscriptions"],"summary":"Subscription - Subscription Activated","description":"A `Subscription` has been activated.","operationId":"webhook-subscription-subscription-activated","parameters":[{"name":"X-Soldo-Fingerprint","in":"header","required":true,"schema":{"type":"string","default":"{{fingerprint}}","description":"[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the [Fingerprint order](ref:fingerprint-order) values.","example":"{{fingerprint}}"}},{"name":"X-Soldo-Fingerprint-Order","in":"header","required":true,"schema":{"type":"string","default":"id, name, platform, status, paymentFrequency, cardId","description":"[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.","example":"id, name, platform, status, paymentFrequency, cardId"}},{"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/SubscriptionActivatedEvent"}}}},"responses":{"200":{"description":"Success."}},"x-soldo":{"fingerprint-order":"id, name, platform, status, paymentFrequency, cardId"}}}}}