Copy taxes to other sites

POST/v1/sites/{siteId}/taxes/copy

Copies taxes from this site to others, keeping their codes, along with what they depend on. Every target is checked before anything is copied; then each is copied in turn. If one fails, those before it stay copied, and the error says which site failed.

Needs Catalogue: writeChanges live data

Path

• siteIdrequired

  The site, from GET /v1/sites.

  string

Headers

• Authorizationrequired

  An API key from Automation > Access in the Dnero portal, sent as Authorization: Bearer <key>.

  string

• Idempotency-Key

  A value you choose, unique to what this request creates: a UUID, or your own id for it. Sending it again with the same body returns the first response and creates nothing more. Required.

  string · at most 255 characters

Body

• codesrequired

  The records to copy, by code at this site.

  array of string · at least 1 · at most 500

• targetSiteIdsrequired

  The sites to copy to. The key needs write access to the catalogue at each.

  array of string · at least 1 · at most 50

• overwriteExisting

  Replace a record a target site already has under the same code. Defaults to true; false copies only what is missing.

  boolean

Responses

• 200OK
• 400Bad Requestbad_requestinvalid_cursoridempotency_key_required
• 401Unauthorizedmissing_keyinvalid_keykey_expired+1 more
• 403Forbiddenkey_revokedassistant_keykey_without_access+7 more
• 404Not Foundsite_not_foundnot_found
• 409Conflictidempotency_key_reusedrequest_in_progress
• 422Unprocessable Entityinvalid_requestnot_a_modifier_group
• 429Too Many Requestsrate_limited
• 500Internal Server Errorserver_error
• 502Bad Gatewayupstream_unavailable

200 OK

• targetsrequired

  Each target site, in the order given.

  array of objects

  3 fields in each

  • changedrequired

    How many records were created or replaced there, including any the copied records need, such as their category.

    integer

  • namerequired

    The target site's name.

    string

  • siteIdrequired

    The target site.

    string

curlJavaScriptPython

curl -X POST "https://api.dev.dnerohq.com/v1/sites/{siteId}/taxes/copy" \
  -H "Authorization: Bearer $DNERO_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "codes": [
    ""
  ],
  "targetSiteIds": [
    ""
  ]
}'

const response = await fetch('https://api.dev.dnerohq.com/v1/sites/{siteId}/taxes/copy', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.DNERO_API_KEY}`,
    'Idempotency-Key': crypto.randomUUID(),
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "codes": [
      ""
    ],
    "targetSiteIds": [
      ""
    ]
  }),
})
const data = await response.json()

import os, uuid
import requests

response = requests.post(
    "https://api.dev.dnerohq.com/v1/sites/{siteId}/taxes/copy",
    headers={"Authorization": f"Bearer {os.environ['DNERO_API_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
    json={
      "codes": [
        ""
      ],
      "targetSiteIds": [
        ""
      ]
    },
)
data = response.json()

200OKapplication/json

{
  "targets": [
    {
      "changed": 4,
      "name": "Ponsonby",
      "siteId": "c00e6138-5881-400d-bfec-410a1daa9a1a"
    }
  ]
}

400Bad Requestapplication/problem+json

{
  "type": "https://developers.dnerohq.com/guides/errors/#bad_request",
  "title": "Bad Request",
  "status": 400,
  "detail": "The request could not be read, for example malformed JSON.",
  "code": "bad_request"
}

401Unauthorizedapplication/problem+json

{
  "type": "https://developers.dnerohq.com/guides/errors/#missing_key",
  "title": "Unauthorized",
  "status": 401,
  "detail": "No API key was sent.",
  "code": "missing_key"
}

403Forbiddenapplication/problem+json

{
  "type": "https://developers.dnerohq.com/guides/errors/#key_revoked",
  "title": "Forbidden",
  "status": 403,
  "detail": "The key was revoked or switched off in the Dnero portal.",
  "code": "key_revoked"
}

404Not Foundapplication/problem+json

{
  "type": "https://developers.dnerohq.com/guides/errors/#site_not_found",
  "title": "Not Found",
  "status": 404,
  "detail": "The key does not reach that site, or there is no such site.",
  "code": "site_not_found"
}

409Conflictapplication/problem+json

{
  "type": "https://developers.dnerohq.com/guides/errors/#idempotency_key_reused",
  "title": "Conflict",
  "status": 409,
  "detail": "This `Idempotency-Key` was already used for a different request.",
  "code": "idempotency_key_reused"
}

422Unprocessable Entityapplication/problem+json

{
  "type": "https://developers.dnerohq.com/guides/errors/#invalid_request",
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "The request was read but is not valid.",
  "code": "invalid_request"
}

429Too Many Requestsapplication/problem+json

{
  "type": "https://developers.dnerohq.com/guides/errors/#rate_limited",
  "title": "Too Many Requests",
  "status": 429,
  "detail": "The key has used its requests for this minute.",
  "code": "rate_limited"
}

500Internal Server Errorapplication/problem+json

{
  "type": "https://developers.dnerohq.com/guides/errors/#server_error",
  "title": "Internal Server Error",
  "status": 500,
  "detail": "Something went wrong on Dnero's side. It has been logged.",
  "code": "server_error"
}

502Bad Gatewayapplication/problem+json

{
  "type": "https://developers.dnerohq.com/guides/errors/#upstream_unavailable",
  "title": "Bad Gateway",
  "status": 502,
  "detail": "Something Dnero depends on did not answer in time.",
  "code": "upstream_unavailable"
}

Examples use this site's API host. Keep the key in $DNERO_API_KEY; never paste it into code.