Consultar nómina

GET

/payroll/batches/{id}

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

curl --fail-with-body --request GET \
  --url "$FACTUCAT_API_URL/payroll/batches/$DOCUMENT_ID" \
  --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/batches/${id}`, {
  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/batches/{id}",
    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/batches/" + id, 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

required

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

userId

required

string

>= 1 characters

title

required

string

status

required

string

Allowed values: draft stamping partially_stamped stamped cancelled error

periodStart

required

string format: date

/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$/

periodEnd

required

string format: date

paymentDate

string format: date

sendEmailOnStamp

required

boolean

allowManualImssOverride

required

boolean

totalReceipts

required

integer

<= 9007199254740991

stampedReceipts

required

integer

<= 9007199254740991

errorReceipts

required

integer

<= 9007199254740991

cancelledReceipts

required

integer

<= 9007199254740991

subtotalPerceptions

required

number

subtotalDeductions

required

number

totalNet

required

number

stampedAt

string format: date-time

cancelledAt

string format: date-time

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

receipts

required

Array<object>

object

required

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

batchId

required

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

userId

required

string

>= 1 characters

employeeId

required

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

employeeNumber

required

string

employeeFullName

required

string

employeeRfc

required

string

employeeCurp

required

string

employeePostalCode

required

string

employeeFiscalRegime

required

string

employeeEmail

string format: email

/^(?:[A-Za-z0-9_'+\-]+\.)*[A-Za-z0-9_'+\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$/

contractType

required

string

payrollRegimeType

required

string

paymentPeriodicity

required

string

federalEntityCode

required

string

periodStart

required

string format: date

periodEnd

required

string format: date

paymentDate

string format: date

serie

string

folio

required

string

inputMode

required

string

Allowed values: net gross

inputSalaryPeriod

required

number

grossSalaryPeriod

required

number

netSalaryPeriod

required

number

integratedDailySalary

required

number

isrBeforeSubsidy

required

number

employmentSubsidy

required

number

isrWithholding

required

number

imssWithholding

required

number

isLegallyCompleteForStamp

required

boolean

imssIncidences

required

object

daysCotizadosImss

required

integer

<= 31

daysAusentismo

required

integer

<= 31

daysIncapacidad

required

integer

<= 31

notes

string

<= 500 characters

imssDetail

required

object

status

required

string

Allowed values: calculated_legal manual_override incomplete_legal_data omitted_by_employer_policy not_applicable_regime

legallyCompleteForStamp

required

boolean

warnings

required

Array<string>

periodStart

required

string format: date

periodEnd

required

string format: date

daysPeriod

required

integer

<= 9007199254740991

daysCotizadosImss

required

integer

<= 9007199254740991

daysAusentismo

required

integer

<= 9007199254740991

daysIncapacidad

required

integer

<= 9007199254740991

notes

string

sbcDailyInput

required

number

sbcDailyLegal

required

number

basePeriod

required

number

baseExcedente

required

number

breakdown

required

object

emExcedente

required

number

emPrestacionesDinero

required

number

emGastosMedPensionados

required

number

invalidezVida

required

number

cesantiaVejez

required

number

total

required

number

segments

required

Array<object>

object

startDate

required

string format: date

endDate

required

string format: date

daysInSegment

required

integer

<= 9007199254740991

daysCotizados

required

integer

<= 9007199254740991

umaDaily

required

number

minimumWageDaily

required

number

versionTag

required

string

sbcLegalDaily

required

number

basePeriod

required

number

baseExcedente

required

number

breakdown

required

object

emExcedente

required

number

emPrestacionesDinero

required

number

emGastosMedPensionados

required

number

invalidezVida

required

number

cesantiaVejez

required

number

total

required

number

parameterVersionTags

required

Array<string>

otherPerceptionsTotal

required

number

otherDeductionsTotal

required

number

otherPaymentsTotal

required

number

totalPerceptions

required

number

totalDeductions

required

number

netPayable

required

number

calculationWarnings

required

Array<string>

status

required

string

Allowed values: draft ready stamping stamped error cancelled

satUuid

string

stampErrorMessage

string

cancellationEvidence

object

source

required

string

Allowed values: cancel_request cancel_response sat_query sat_query_error

state

string

cancelUuidCode

string

esCancelable

string

estatusCancelacion

string

validacionEfos

string

lastCheckedAt

required

string format: date-time

attempts

required

integer

<= 9007199254740991

needsVerification

required

boolean

lastError

string

lastEmailSentAt

string format: date-time

stampedAt

string format: date-time

cancelledAt

string format: date-time

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

concepts

required

Array<object>

object

kind

required

string

Allowed values: perception deduction other_payment

humanCode

required

string

Allowed values: SALARIO_BASE BONO AGUINALDO DESCUENTO ISR IMSS SUBSIDIO_AL_EMPLEO OTRO

amount

required

number

<= 99999999

satCode

required

string

>= 1 characters <= 10 characters

description

required

string

>= 1 characters <= 200 characters

taxableAmount

required

number

exemptAmount

required

number

editable

required

boolean

cancellationReceipts

required

Array<object>

object

required

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

receiptId

required

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

cancelledSatUuid

required

string

>= 1 characters

replacementSatUuid

string

cancelReason

required

string

Allowed values: 01 02 03 04

createdAt

required

string format: date-time

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