← HomeFleetPay / Schema

InboundCteCarrierRole

Structure preserved from the versioned API contract.

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

YOUR company's role in the received CT-e, read from the XML. It determines whether the document allows you to issue a counter-CT-e.

  • subcontracted — you are neither the issuer nor a party to the cargo: this is subcontracting, the only role that allows a counter-CT-e;
  • issuer — your own company issued the CT-e;
  • sender — you are the cargo sender;
  • recipient — you are the cargo recipient.
Original JSON Definition (Portuguese Descriptions)
{
  "type": "string",
  "description": "O papel da SUA empresa dentro do CT-e recebido, lido do XML. É ele que decide se aquele\ndocumento admite um contra-CT-e seu.\n\n- `subcontracted` — você não é o emitente nem parte da carga: é o caso da subcontratação,\n  o único que admite contra-CT-e;\n- `issuer` — o CT-e foi emitido pela sua própria empresa;\n- `sender` — você é o remetente da carga;\n- `recipient` — você é o destinatário da carga.\n",
  "enum": [
    "subcontracted",
    "issuer",
    "sender",
    "recipient"
  ]
}