Descargar XML de nómina en base64

GET

/payroll/receipts/{id}/xml

FACTUCAT_API_URL="${FACTUCAT_API_URL:-https://sandbox.factucat.com/api/v1}"

curl --fail-with-body --request GET \
  --url "$FACTUCAT_API_URL/payroll/receipts/$DOCUMENT_ID/xml" \
  --header "X-API-Key: $FACTUCAT_API_KEY"

const baseUrl = process.env.FACTUCAT_API_URL || "https://sandbox.factucat.com/api/v1"
const id = process.env.DOCUMENT_ID
const response = await fetch(`${baseUrl}/payroll/receipts/${id}/xml`, {
  method: "GET",
  headers: {
    'X-API-Key': process.env.FACTUCAT_API_KEY,
  },
})
const text = await response.text()
if (!response.ok) throw new Error(`HTTP ${response.status}: ${text}`)
console.log(JSON.parse(text))

import json
import os
import urllib.error
import urllib.request

base_url = os.environ.get("FACTUCAT_API_URL", "https://sandbox.factucat.com/api/v1")
id = os.environ["DOCUMENT_ID"]
request = urllib.request.Request(
    f"{base_url}/payroll/receipts/{id}/xml",
    method="GET",
    headers={
        "X-API-Key": os.environ["FACTUCAT_API_KEY"],
    },
)
try:
    with urllib.request.urlopen(request) as response:
        text = response.read().decode("utf-8")
except urllib.error.HTTPError as error:
    raise RuntimeError(f"HTTP {error.code}: {error.read().decode('utf-8')}") from error
print(json.loads(text))

package main

import (
  "fmt"
  "io"
  "net/http"
  "os"
)

func main() {
  baseURL := os.Getenv("FACTUCAT_API_URL")
  if baseURL == "" { baseURL = "https://sandbox.factucat.com/api/v1" }
  id := os.Getenv("DOCUMENT_ID")
  request, err := http.NewRequest("GET", baseURL + "/payroll/receipts/" + id + "/xml", nil)
  if err != nil { panic(err) }
  request.Header.Set("X-API-Key", os.Getenv("FACTUCAT_API_KEY"))
  response, err := http.DefaultClient.Do(request)
  if err != nil { panic(err) }
  defer response.Body.Close()
  text, _ := io.ReadAll(response.Body)
  if response.StatusCode < 200 || response.StatusCode >= 300 {
    panic(fmt.Sprintf("HTTP %d: %s", response.StatusCode, text))
  }
  fmt.Print(string(text))
}

Solo lectura. Requiere payroll:read y acceso a nómina de Plan Miau. Despacho en modo de solo lectura conserva acceso. OAuth usa el espacio seleccionado al autorizar; las API keys usan su cuenta propietaria. CURP, NSS y cuenta bancaria se enmascaran salvo en los documentos fiscales XML y PDF.

Authorizations

apiKeyAuth
payrollOAuth

Parameters

Path Parameters

required

string format: uuid

Responses

200

Operación exitosa

application/json

object

data

required

object

fileName

required

string

mimeType

required

string

base64

required

string

meta

required

object

requestId

required

string

>= 1 characters

idempotencyKey

string

>= 1 characters

pagination

object

limit

required

integer

> 0 <= 9007199254740991

offset

required

integer

<= 9007199254740991

hasMore

required

boolean

nextCursor

string | null

400

Datos inválidos

application/json

object

error

required

object

code

required

string

Allowed values: bad_request conflict csd_required forbidden internal_error pac_unavailable invalid_api_key invalid_json method_not_allowed missing_api_key missing_idempotency_key missing_scope not_found plan_required rate_limit_exceeded validation_error invalid_input INVALID_ISSUE_DATE idempotency_conflict idempotency_in_progress

message

required

string

>= 1 characters

requestId

required

string

>= 1 characters

retryable

required

boolean

reason

string

401

API key ausente, inválida o de otro ambiente

application/json

object

error

required

object

code

required

string

message

required

string

>= 1 characters

requestId

required

string

>= 1 characters

retryable

required

boolean

reason

string

403

Plan inactivo o permisos insuficientes

application/json

object

error

required

object

code

required

string

message

required

string

>= 1 characters

requestId

required

string

>= 1 characters

retryable

required

boolean

reason

string

404

Recurso no encontrado

application/json

object

error

required

object

code

required

string

message

required

string

>= 1 characters

requestId

required

string

>= 1 characters

retryable

required

boolean

reason

string

405

Método no permitido

application/json

object

error

required

object

code

required

string

message

required

string

>= 1 characters

requestId

required

string

>= 1 characters

retryable

required

boolean

reason

string

409

Conflicto o solicitud en curso. error.reason es opcional; duplicate_rfc indica que ya existe un cliente con ese RFC en la cuenta; stamp_in_progress indica que el documento se está timbrando: consúltalo antes de reintentar.

application/json

object

error

required

object

code

required

string

message

required

string

>= 1 characters

requestId

required

string

>= 1 characters

retryable

required

boolean

reason

string

429

Límite de solicitudes alcanzado

application/json

object

error

required

object

code

required

string

message

required

string

>= 1 characters

requestId

required

string

>= 1 characters

retryable

required

boolean

reason

string

Headers

Retry-After

integer

Segundos antes de reintentar.

500

Error interno

application/json

object

error

required

object

code

required

string

message

required

string

>= 1 characters

requestId

required

string

>= 1 characters

retryable

required

boolean

reason

string

503

PAC temporalmente no disponible

application/json

object

error

required

object

code

required

string

message

required

string

>= 1 characters

requestId

required

string

>= 1 characters

retryable

required

boolean

reason

string