Skip to content
campaiDeveloper
campai.com

Finance · Receipts

POST/{organizationId}/{mandateId}/finance/receipts/tags/rename

Rename tag

Renames a receipt tag case-insensitively, or merges it with an existing tag. Provide the organization, mandate, current tag and new tag; the response gives affectedRecords, the number of matching receipts. Receipt updates run in the background.

Permissions

Send an API key of the organization in the path, using the X-API-Key header.

Who may call it

  • The caller must have organization access.
  • The caller needs the receipt.remove permission.

Request

Path parameters

  • organizationIdidrequired
  • mandateIdidrequired

Body

Content-Type: application/json

  • tagstringrequired

    1–40 characters

  • newTagstringrequired

    1–40 characters

Request
curl --fail-with-body --silent --show-error --max-time 30 --globoff \
  --request POST 'https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/YOUR_MANDATE_ID/finance/receipts/tags/rename' \
  --header 'X-API-Key: YOUR_API_KEY'

No request that worked has been recorded yet, so the body is not shown.

Response

200 Successful response

Content-Type: application/json

  • affectedRecordsinteger

    at least 0

Response200
{
  "affectedRecords": 0
}

What else happens

  • When the old and new names have the same normalized form, matching tag records are updated with the new spelling.
  • When the normalized names differ, matching old tag records are deleted.
  • When the normalized names differ and receipts gain the new tag, its tag records are created or updated and their usage counts increased.
  • Queues the common.renameTagInEntities job on DefaultQueue to update receipt tags.

Errors

No errors of its own are known for this endpoint.

Errors nearly every request can meet are listed under Errors.