← HomeFleetPay / API

Remove an unlinked NF-e

Parameters, data structure and responses from the versioned contract.

DELETE/fiscal/nfe/{access_key}

deleteNfeSandbox Base: https://api.fleetpay.site/v1

Technical descriptions are translated from the versioned contract. Original identifiers and JSON are preserved; data examples are omitted.

Authentication

[
  {
    "oauth2": []
  },
  {
    "chaveApi": []
  }
]

Availability depends on the environment, enabled scopes and provider. This reference does not execute requests or collect credentials.

Parameters

access_keypath · stringRequired

NF-e access key, with 44 digits.

Constraints

{
  "type": "string",
  "pattern": "^\\d{44}$"
}

Responses

204 HTTP Response

NF-e removed; no response body.

Headers

X-Request-Id

Call correlation identifier.

401 HTTP Response

FleetPay API key missing or invalid.

`application/json`

ErrorEnvelope ↗

errorobjectRequired

ErrorBody ↗

Headers

X-Request-Id

Call correlation identifier.

403 HTTP Response

Fiscal scope disabled for the key, or no active carrier associated with the key.

`application/json`

ErrorEnvelope ↗

errorobjectRequired

ErrorBody ↗

Headers

X-Request-Id

Call correlation identifier.

404 HTTP Response

Resource not found in the authenticated tenant.

`application/json`

ErrorEnvelope ↗

errorobjectRequired

ErrorBody ↗

Headers

X-Request-Id

Call correlation identifier.

422 HTTP Response

An outstanding requirement or business rule prevented the operation.

`application/json`

ErrorEnvelope ↗

errorobjectRequired

ErrorBody ↗

Headers

X-Request-Id

Call correlation identifier.

429 HTTP Response

Per-carrier limit exceeded.

`application/json`

ErrorEnvelope ↗

errorobjectRequired

ErrorBody ↗

Headers

X-Request-Id

Call correlation identifier.

Retry-After

Seconds until another attempt.

500 HTTP Response

Internal failure without operational integration details.

`application/json`

ErrorEnvelope ↗

errorobjectRequired

ErrorBody ↗

Headers

X-Request-Id

Call correlation identifier.

Complete Operation Definition

{
  "tags": [
    "NF-e"
  ],
  "summary": "Remover NF-e não vinculada",
  "operationId": "deleteNfe",
  "responses": {
    "204": {
      "description": "NF-e removida; sem corpo.",
      "headers": {
        "X-Request-Id": {
          "$ref": "#/components/headers/RequestId"
        }
      }
    },
    "401": {
      "$ref": "#/components/responses/Unauthorized"
    },
    "403": {
      "$ref": "#/components/responses/Forbidden"
    },
    "404": {
      "$ref": "#/components/responses/NotFound"
    },
    "422": {
      "$ref": "#/components/responses/BusinessRuleFailed"
    },
    "429": {
      "$ref": "#/components/responses/RateLimited"
    },
    "500": {
      "$ref": "#/components/responses/InternalError"
    }
  },
  "method": "DELETE",
  "path": "/fiscal/nfe/{access_key}",
  "parameters": [
    {
      "$ref": "#/components/parameters/NfeAccessKey"
    }
  ]
}