Negocio

Actualizar el negocio

PATCH

/v1/business

const url = 'https://api.timbro.do/v1/business';
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"expectedRevision":1,"capabilities":{"payments":{"requested":true},"invoices":{"requested":true}},"fiscalDetails":{"commercialName":"example","address":"example","location":{"placeId":"example","catalogReleaseId":"example"},"phone":"example","defaultIncomeType":"01"},"paymentsProfile":{"displayName":"example","statementDescriptor":"example","permanentAddress":{"line1":"example","line2":"example","city":"example","province":"example","postalCode":"example","countryCode":"example"},"supportEmail":"hello@example.com","supportPhone":"example","deliveryPolicy":{"kind":"not_offered"}}}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request PATCH \
  --url https://api.timbro.do/v1/business \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "expectedRevision": 1, "capabilities": { "payments": { "requested": true }, "invoices": { "requested": true } }, "fiscalDetails": { "commercialName": "example", "address": "example", "location": { "placeId": "example", "catalogReleaseId": "example" }, "phone": "example", "defaultIncomeType": "01" }, "paymentsProfile": { "displayName": "example", "statementDescriptor": "example", "permanentAddress": { "line1": "example", "line2": "example", "city": "example", "province": "example", "postalCode": "example", "countryCode": "example" }, "supportEmail": "hello@example.com", "supportPhone": "example", "deliveryPolicy": { "kind": "not_offered" } } }'

Reemplaza cada sección que envías: las capacidades solicitadas, los datos fiscales incluidos o el perfil completo de pagos. El servidor prepara los servicios que permita la nueva configuración.

Autenticación

adminKey

Cuerpo de la solicitud^obligatorio

application/json

Cada miembro que trae la solicitud reemplaza ese miembro del negocio.

object

expectedRevision

integer

capabilities

object

payments

object

requested

obligatorio

boolean

invoices

object

requested

obligatorio

boolean

fiscalDetails

object

commercialName

string

>= 1 characters <= 150 characters /^(?=[\s\S]*\p{L})(?=\s*\S(?:[\s\S]*\S){1})(?!\s*(\S)\1*\s*$)[\s\S]{1,150}$/

address

string

>= 1 characters <= 100 characters /^(?=[\s\S]*\p{L})(?=\s*\S(?:[\s\S]*\S){2})(?!\s*(\S)\1*\s*$)[\s\S]{1,100}$/

location

Cualquiera de:

BusinessLocationPlace
BusinessLocationMunicipality

object

placeId

obligatorio

string

/^place_[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$/

catalogReleaseId

obligatorio

string

/^dr_[A-Za-z0-9._-]+$/

phone

Número telefónico dominicano del negocio en formato E.164.

string

/^\+1(?:809|829|849)[0-9]{7}$/

defaultIncomeType

Cualquiera de:

string

Valor permitido: 01

paymentsProfile

Soporte, dirección y condiciones de entrega que ve el cliente. La razón social y el RNC son los del negocio.

object

displayName

obligatorio

string

>= 2 characters <= 80 characters /^(?=[\s\S]*\p{L})(?=\s*\S(?:[\s\S]*\S){1})(?!\s*(\S)\1*\s*$)[\s\S]+$/

statementDescriptor

obligatorio

string

>= 2 characters <= 22 characters /^(?=[\s\S]*\p{L})(?=\s*\S(?:[\s\S]*\S){1})(?!\s*(\S)\1*\s*$)[\s\S]+$/

permanentAddress

obligatorio

Dirección comercial permanente del comercio vendedor.

object

line1

obligatorio

string

>= 3 characters <= 160 characters /^(?=[\s\S]*\p{L})(?=\s*\S(?:[\s\S]*\S){2})(?!\s*(\S)\1*\s*$)[\s\S]+$/

city

obligatorio

string

>= 2 characters <= 80 characters /^(?=[\s\S]*\p{L})(?=\s*\S(?:[\s\S]*\S){1})(?!\s*(\S)\1*\s*$)[\s\S]+$/

countryCode

obligatorio

string

/^[A-Z]{2}$/

line2

string

>= 1 characters <= 160 characters /\S/

province

string

>= 1 characters <= 80 characters /\S/

postalCode

string

>= 1 characters <= 20 characters /\S/

supportEmail

obligatorio

string format: email

<= 254 characters

supportPhone

obligatorio

string

/^\+[1-9][0-9]{7,14}$/

deliveryPolicy

obligatorio

discriminator: kind

DeliveryNotOffered
MerchantManagedDelivery

object

kind

obligatorio

string

Valor permitido: not_offered

Respuestas

200

El negocio que selecciona la credencial, sus capacidades y los requisitos que faltan.

application/json

Campos y códigos de la respuesta

El negocio que selecciona la credencial, sus capacidades y los requisitos que faltan.

object

object

obligatorio

string

Valor permitido: business

obligatorio

string

/^business_[0-9a-hjkmnp-tv-z]{24,}$/

rnc

obligatorio

string

/^[0-9]{9}$/

legalName

obligatorio

string

>= 1 characters

economicActivity

obligatorio

Cualquiera de:

string
null

string

>= 1 characters <= 512 characters

revision

obligatorio

integer

capabilities

obligatorio

El live.status de facturas es active solo cuando el certificado digital en vivo está activo y al menos un tipo de e-CF de invoicing.live.documentTypes está ready. Una lista vacía o ilegible nunca es active; los requirements con mode: "live" indican qué falta.

object

payments

obligatorio

object

requested

obligatorio

boolean

test

obligatorio

object

status

obligatorio

Cualquiera de:

string

Valor permitido: active

live

obligatorio

object

status

obligatorio

Cualquiera de:

string

Valor permitido: active

invoices

obligatorio

object

requested

obligatorio

boolean

test

obligatorio

object

status

obligatorio

Cualquiera de:

string

Valor permitido: active

live

obligatorio

object

status

obligatorio

Cualquiera de:

string

Valor permitido: active

fiscalDetails

obligatorio

object

commercialName

obligatorio

Cualquiera de:

string
null

string

address

obligatorio

Cualquiera de:

string
null

string

location

obligatorio

Cualquiera de:

object
null

object

placeId

obligatorio

string

/^place_[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$/

catalogReleaseId

obligatorio

string

/^dr_[A-Za-z0-9._-]+$/

municipalityCode

obligatorio

Cualquiera de:

string
null

string

/^[0-9]{6}$/

name

obligatorio

string

>= 1 characters <= 160 characters

kind

obligatorio

Cualquiera de:

string

Valor permitido: country

qualityStatus

obligatorio

Cualquiera de:

string

Valor permitido: verified

ancestors

obligatorio

Los lugares que contienen al seleccionado, del más externo al más interno.

Array<object>

<= 32 items

object

placeId

obligatorio

string

/^place_[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$/

name

obligatorio

string

>= 1 characters <= 160 characters

kind

obligatorio

Cualquiera de:

string

Valor permitido: country

qualityStatus

obligatorio

Cualquiera de:

string

Valor permitido: verified

phone

obligatorio

Cualquiera de:

string
null

string

email

obligatorio

Cualquiera de:

string
null

string

defaultIncomeType

obligatorio

Cualquiera de:

string
null

string

paymentsProfile

obligatorio

Cualquiera de:

MerchantPaymentsProfile
null

Soporte, dirección y condiciones de entrega que ve el cliente. La razón social y el RNC son los del negocio.

object

displayName

obligatorio

string

>= 2 characters <= 80 characters /^(?=[\s\S]*\p{L})(?=\s*\S(?:[\s\S]*\S){1})(?!\s*(\S)\1*\s*$)[\s\S]+$/

statementDescriptor

obligatorio

string

>= 2 characters <= 22 characters /^(?=[\s\S]*\p{L})(?=\s*\S(?:[\s\S]*\S){1})(?!\s*(\S)\1*\s*$)[\s\S]+$/

permanentAddress

obligatorio

Dirección comercial permanente del comercio vendedor.

object

line1

obligatorio

string

>= 3 characters <= 160 characters /^(?=[\s\S]*\p{L})(?=\s*\S(?:[\s\S]*\S){2})(?!\s*(\S)\1*\s*$)[\s\S]+$/

city

obligatorio

string

>= 2 characters <= 80 characters /^(?=[\s\S]*\p{L})(?=\s*\S(?:[\s\S]*\S){1})(?!\s*(\S)\1*\s*$)[\s\S]+$/

countryCode

obligatorio

string

/^[A-Z]{2}$/

line2

string

>= 1 characters <= 160 characters /\S/

province

string

>= 1 characters <= 80 characters /\S/

postalCode

string

>= 1 characters <= 20 characters /\S/

supportEmail

obligatorio

string format: email

<= 254 characters

supportPhone

obligatorio

string

/^\+[1-9][0-9]{7,14}$/

deliveryPolicy

obligatorio

discriminator: kind

DeliveryNotOffered
MerchantManagedDelivery

object

kind

obligatorio

string

Valor permitido: not_offered

paymentsProfileOrigin

obligatorio

Cualquiera de:

unknown
null

Cualquiera de:

string
string

string

Valor permitido: derived

invoicing

obligatorio

object

test

obligatorio

Cualquiera de:

BusinessFiscalSetupUnavailable
BusinessFiscalSetupAvailable

object

status

obligatorio

string

Valor permitido: unavailable

cause

obligatorio

string

Valor permitido: timbro_unreachable

object

status

obligatorio

string

Valor permitido: available

binding

obligatorio

discriminator: status

object

status

obligatorio

string

Valor permitido: unbound

legalIssuer

obligatorio

discriminator: status

object

status

obligatorio

string

Valor permitido: missing

signingCertificate

obligatorio

discriminator: status

BusinessSigningCertificateMissing
BusinessSigningCertificateActive

object

status

obligatorio

string

Valor permitido: missing

testFiscalDocument

obligatorio

discriminator: status

object

status

obligatorio

string

Valor permitido: not_sent

documentTypes

obligatorio

Cualquiera de:

Array
null

Array

discriminator: status

DocumentTypeReadyToIssue
DocumentTypeActionRequired

object

type

obligatorio

Cualquiera de:

string

Valor permitido: E31

status

obligatorio

string

Valor permitido: ready

numbering

obligatorio

El rango del que Timbro asigna el próximo e-NCF de este tipo.

object

remaining

obligatorio

Cantidad de e-NCF que quedan en el rango seleccionado.

integer

>= 1 <= 9999999999

confirmation

obligatorio

Cualquiera de:

string
string

string

Valor permitido: confirmed

expiresOn

obligatorio

Cualquiera de:

string
null

El vencimiento de la secuencia, o null para un tipo que no lo tiene (E32 y E34).

string format: date

object

type

obligatorio

Cualquiera de:

string

Valor permitido: E31

status

obligatorio

string

Valor permitido: actionRequired

reasons

obligatorio

Cada condición que bloquea este tipo: primero el emisor, luego el certificado y por último la numeración.

Array

>= 1 items

numbering

obligatorio

Cualquiera de:

NumberingRange
null

El rango del que Timbro asigna el próximo e-NCF de este tipo.

object

remaining

obligatorio

Cantidad de e-NCF que quedan en el rango seleccionado.

integer

>= 1 <= 9999999999

confirmation

obligatorio

Cualquiera de:

string
string

string

Valor permitido: confirmed

expiresOn

obligatorio

Cualquiera de:

string
null

El vencimiento de la secuencia, o null para un tipo que no lo tiene (E32 y E34).

string format: date

live

obligatorio

Cualquiera de:

BusinessFiscalSetupUnavailable
BusinessLiveFiscalSetupAvailable

object

status

obligatorio

string

Valor permitido: unavailable

cause

obligatorio

string

Valor permitido: timbro_unreachable

object

status

obligatorio

string

Valor permitido: available

binding

obligatorio

discriminator: status

object

status

obligatorio

string

Valor permitido: unbound

legalIssuer

obligatorio

discriminator: status

object

status

obligatorio

string

Valor permitido: missing

signingCertificate

obligatorio

discriminator: status

BusinessSigningCertificateMissing
BusinessSigningCertificateActive

object

status

obligatorio

string

Valor permitido: missing

documentTypes

obligatorio

Cualquiera de:

Array
null

Array

discriminator: status

DocumentTypeReadyToIssue
DocumentTypeActionRequired

object

type

obligatorio

Cualquiera de:

string

Valor permitido: E31

status

obligatorio

string

Valor permitido: ready

numbering

obligatorio

El rango del que Timbro asigna el próximo e-NCF de este tipo.

object

remaining

obligatorio

Cantidad de e-NCF que quedan en el rango seleccionado.

integer

>= 1 <= 9999999999

confirmation

obligatorio

Cualquiera de:

string
string

string

Valor permitido: confirmed

expiresOn

obligatorio

Cualquiera de:

string
null

El vencimiento de la secuencia, o null para un tipo que no lo tiene (E32 y E34).

string format: date

object

type

obligatorio

Cualquiera de:

string

Valor permitido: E31

status

obligatorio

string

Valor permitido: actionRequired

reasons

obligatorio

Cada condición que bloquea este tipo: primero el emisor, luego el certificado y por último la numeración.

Array

>= 1 items

numbering

obligatorio

Cualquiera de:

NumberingRange
null

El rango del que Timbro asigna el próximo e-NCF de este tipo.

object

remaining

obligatorio

Cantidad de e-NCF que quedan en el rango seleccionado.

integer

>= 1 <= 9999999999

confirmation

obligatorio

Cualquiera de:

string
string

string

Valor permitido: confirmed

expiresOn

obligatorio

Cualquiera de:

string
null

El vencimiento de la secuencia, o null para un tipo que no lo tiene (E32 y E34).

string format: date

sequences

obligatorio

Cualquiera de:

Array<object>
null

Array<object>

Secuencia de e-NCF que el negocio registró desde la Oficina Virtual de la DGII, tal como la registró. Las respuestas de la DGII la confirman; documentTypes[].numbering.confirmation y sequence_rejected_by_dgii lo informan.

object

documentType

obligatorio

Cualquiera de:

string

Valor permitido: E31

firstNumber

obligatorio

Primer número que otorgó la DGII.

integer

>= 1 <= 9999999999

lastNumber

obligatorio

Último número que otorgó la DGII.

integer

>= 1 <= 9999999999

nextNumber

obligatorio

Cualquiera de:

integer
null

Próximo número que estaba sin usar cuando el negocio registró la secuencia, o null cuando ya no queda ninguno. Timbro avanza desde ahí al emitir; documentTypes indica cuántos números quedan.

integer

>= 1 <= 9999999999

expiresOn

obligatorio

Cualquiera de:

string
null

Día en que vence la secuencia, o null en E32 y E34, que no vencen.

string format: date

requirements

obligatorio

Array<object>

Algo que debe ocurrir antes de que una capacidad esté activa, y quién actúa sobre ello. Mientras una capacidad está activa, un requisito que de otro modo la bloquearía no bloquea nada y es una advertencia. La facturación en vivo lista como máximo un requisito por clase de causa (legal_issuer_profile_required, signing_certificate_required, sequence_required, sequence_confirmation_pending), cada uno con los documentTypes de e-CF que afecta. Cuando Timbro rechazó el perfil del emisor legal en vivo, la primera entrada es fiscal_details_rejected, con field /fiscalDetails. El merchant es responsable de todos salvo sequence_confirmation_pending, que espera a dgii. default_income_type_required está en desuso y ya no se devuelve: un negocio que factura y no tiene tipo de ingreso guardado lee 01.

object

code

obligatorio

Cualquiera de:

string

Valor permitido: capabilities_required

owner

obligatorio

Cualquiera de:

string

Valor permitido: merchant

blocks

obligatorio

Array

<= 2 items

mode

Cualquiera de:

string
string

string

Valor permitido: test

documentTypes

Los tipos de e-CF que este requisito impide emitir, en el orden de los tipos. Ausente cuando aplica a todo el ambiente.

Array

>= 1 items

field

JSON Pointer al campo de esta representación que nombra el requisito.

string

errors

Array<object>

>= 1 items

object

code

obligatorio

string

message

obligatorio

string

onboardingUrl

obligatorio

string format: uri

Cabeceras

request-id

obligatorio

string

Identifica esta solicitud. Indícalo cuando contactes a soporte.

400

No se pudo entender la solicitud.

application/problem+json

Ejemplo

{
  "type": "about:blank",
  "title": "No se pudo entender la solicitud.",
  "status": 400,
  "code": "parameter_missing",
  "requestId": "request_000000000000000000000001"
}

Campos y códigos de la respuesta

Detalles de problema RFC 9457. Cada fallo de esta API es uno de estos objetos y cada operación limita code al subconjunto que puede emitir.

object

code

obligatorio

Código estable legible por máquinas. Toma decisiones con este código, nunca con title.

string

Valores permitidos: parameter_missing parameter_invalid request_body_malformed

requestId

obligatorio

string

status

obligatorio

integer format: int32

>= 400 <= 599

Valor permitido: 400

title

obligatorio

string

type

obligatorio

string

Valores permitidos: about:blank

Campos opcionales

detail

string

invoiceId

Solo aparece si la solicitud rechazada produjo una operación fiscal.

string

issuanceBlockers

Solo aparece cuando las reglas oficiales de emisión rechazan la emisión.

Array<string>

Valores permitidos: invalid_request unsupported_protocol unsupported_rules_version invalid_resolved_facts numbering_verifier_missing numbering_mode_not_enabled document_type_not_recognized sequence_missing sequence_not_observed_on_effective_date sequence_suspended sequence_cancelled sequence_superseded sequence_exhausted sequence_conflicting sequence_document_type_mismatch sequence_rejected_by_dgii sequence_expired sequence_range_overlap fiscal_number_capacity_exhausted invalid_fiscal_number fiscal_number_outside_authorized_range fiscal_number_before_verified_floor sequence_expiration_mismatch

problems

Solo aparece cuando el rechazo señala un valor incluido en la solicitud.

Array<object>

Un problema público estable del documento, guardado para una admisión rechazada.

object

code

obligatorio

string

message

obligatorio

string

path

obligatorio

string

Cabeceras

request-id

obligatorio

string

Identifica esta solicitud. Indícalo cuando contactes a soporte.

401

La credencial falta, tiene un formato incorrecto o ya no es válida.

application/problem+json

Ejemplo

{
  "type": "about:blank",
  "title": "La credencial falta, tiene un formato incorrecto o ya no es válida.",
  "status": 401,
  "code": "person_session_missing",
  "requestId": "request_000000000000000000000001"
}

Campos y códigos de la respuesta

Detalles de problema RFC 9457. Cada fallo de esta API es uno de estos objetos y cada operación limita code al subconjunto que puede emitir.

object

code

obligatorio

Código estable legible por máquinas. Toma decisiones con este código, nunca con title.

string

Valores permitidos: person_session_missing api_key_missing api_key_invalid checkout_token_invalid checkout_token_expired

requestId

obligatorio

string

status

obligatorio

integer format: int32

>= 400 <= 599

Valor permitido: 401

title

obligatorio

string

type

obligatorio

string

Valores permitidos: about:blank

Campos opcionales

detail

string

invoiceId

Solo aparece si la solicitud rechazada produjo una operación fiscal.

string

issuanceBlockers

Solo aparece cuando las reglas oficiales de emisión rechazan la emisión.

Array<string>

problems

Solo aparece cuando el rechazo señala un valor incluido en la solicitud.

Array<object>

Un problema público estable del documento, guardado para una admisión rechazada.

object

code

obligatorio

string

message

obligatorio

string

path

obligatorio

string

Cabeceras

request-id

obligatorio

string

Identifica esta solicitud. Indícalo cuando contactes a soporte.

403

La credencial es válida, pero no tiene permiso para realizar esta operación.

application/problem+json

Ejemplo

{
  "type": "about:blank",
  "title": "La credencial es válida, pero no tiene permiso para realizar esta operación.",
  "status": 403,
  "code": "operation_not_permitted",
  "requestId": "request_000000000000000000000001"
}

Campos y códigos de la respuesta

Detalles de problema RFC 9457. Cada fallo de esta API es uno de estos objetos y cada operación limita code al subconjunto que puede emitir.

object

code

obligatorio

Código estable legible por máquinas. Toma decisiones con este código, nunca con title.

string

Valores permitidos: operation_not_permitted

requestId

obligatorio

string

status

obligatorio

integer format: int32

>= 400 <= 599

Valor permitido: 403

title

obligatorio

string

type

obligatorio

string

Valores permitidos: about:blank

Campos opcionales

detail

string

invoiceId

Solo aparece si la solicitud rechazada produjo una operación fiscal.

string

issuanceBlockers

Solo aparece cuando las reglas oficiales de emisión rechazan la emisión.

Array<string>

problems

Solo aparece cuando el rechazo señala un valor incluido en la solicitud.

Array<object>

Un problema público estable del documento, guardado para una admisión rechazada.

object

code

obligatorio

string

message

obligatorio

string

path

obligatorio

string

Cabeceras

request-id

obligatorio

string

Identifica esta solicitud. Indícalo cuando contactes a soporte.

404

Ningún endpoint sirve este método y ruta, o no existe un recurso con este identificador dentro del alcance del solicitante.

application/problem+json

Ejemplo

{
  "type": "about:blank",
  "title": "Ningún endpoint sirve este método y ruta, o no existe un recurso con este identificador dentro del alcance del solicitante.",
  "status": 404,
  "code": "business_not_found",
  "requestId": "request_000000000000000000000001"
}

Campos y códigos de la respuesta

Detalles de problema RFC 9457. Cada fallo de esta API es uno de estos objetos y cada operación limita code al subconjunto que puede emitir.

object

code

obligatorio

Código estable legible por máquinas. Toma decisiones con este código, nunca con title.

string

Valores permitidos: business_not_found

requestId

obligatorio

string

status

obligatorio

integer format: int32

>= 400 <= 599

Valor permitido: 404

title

obligatorio

string

type

obligatorio

string

Valores permitidos: about:blank

Campos opcionales

detail

string

invoiceId

Solo aparece si la solicitud rechazada produjo una operación fiscal.

string

issuanceBlockers

Solo aparece cuando las reglas oficiales de emisión rechazan la emisión.

Array<string>

problems

Solo aparece cuando el rechazo señala un valor incluido en la solicitud.

Array<object>

Un problema público estable del documento, guardado para una admisión rechazada.

object

code

obligatorio

string

message

obligatorio

string

path

obligatorio

string

Cabeceras

request-id

obligatorio

string

Identifica esta solicitud. Indícalo cuando contactes a soporte.

409

La solicitud entra en conflicto con el estado actual del recurso o con una solicitud anterior que usó la misma clave de idempotencia (Idempotency-Key).

application/problem+json

Ejemplo

{
  "type": "about:blank",
  "title": "La solicitud entra en conflicto con el estado actual del recurso o con una solicitud anterior que usó la misma clave de idempotencia (`Idempotency-Key`).",
  "status": 409,
  "code": "business_contact_email_confirmation_required",
  "requestId": "request_000000000000000000000001"
}

Campos y códigos de la respuesta

Detalles de problema RFC 9457. Cada fallo de esta API es uno de estos objetos y cada operación limita code al subconjunto que puede emitir.

object

code

obligatorio

Código estable legible por máquinas. Toma decisiones con este código, nunca con title.

string

Valores permitidos: business_contact_email_confirmation_required business_address_required business_location_official_codes_required business_details_invalid business_location_catalog_changed business_location_selection_invalid business_guest_notice_acceptance_required business_identity_required business_revision_conflict business_capabilities_required

requestId

obligatorio

string

status

obligatorio

integer format: int32

>= 400 <= 599

Valor permitido: 409

title

obligatorio

string

type

obligatorio

string

Valores permitidos: about:blank

Campos opcionales

detail

string

invoiceId

Solo aparece si la solicitud rechazada produjo una operación fiscal.

string

issuanceBlockers

Solo aparece cuando las reglas oficiales de emisión rechazan la emisión.

Array<string>

problems

Solo aparece cuando el rechazo señala un valor incluido en la solicitud.

Array<object>

Un problema público estable del documento, guardado para una admisión rechazada.

object

code

obligatorio

string

message

obligatorio

string

path

obligatorio

string

Cabeceras

request-id

obligatorio

string

Identifica esta solicitud. Indícalo cuando contactes a soporte.

413

El cuerpo de la solicitud es más grande de lo que acepta este endpoint.

application/problem+json

Ejemplo

{
  "type": "about:blank",
  "title": "El cuerpo de la solicitud es más grande de lo que acepta este endpoint.",
  "status": 413,
  "code": "request_body_too_large",
  "requestId": "request_000000000000000000000001"
}

Campos y códigos de la respuesta

Detalles de problema RFC 9457. Cada fallo de esta API es uno de estos objetos y cada operación limita code al subconjunto que puede emitir.

object

code

obligatorio

Código estable legible por máquinas. Toma decisiones con este código, nunca con title.

string

Valores permitidos: request_body_too_large

requestId

obligatorio

string

status

obligatorio

integer format: int32

>= 400 <= 599

Valor permitido: 413

title

obligatorio

string

type

obligatorio

string

Valores permitidos: about:blank

Campos opcionales

detail

string

invoiceId

Solo aparece si la solicitud rechazada produjo una operación fiscal.

string

issuanceBlockers

Solo aparece cuando las reglas oficiales de emisión rechazan la emisión.

Array<string>

problems

Solo aparece cuando el rechazo señala un valor incluido en la solicitud.

Array<object>

Un problema público estable del documento, guardado para una admisión rechazada.

object

code

obligatorio

string

message

obligatorio

string

path

obligatorio

string

Cabeceras

request-id

obligatorio

string

Identifica esta solicitud. Indícalo cuando contactes a soporte.

415

El cuerpo de la solicitud tiene un tipo de contenido que este endpoint no acepta.

application/problem+json

Ejemplo

{
  "type": "about:blank",
  "title": "El cuerpo de la solicitud tiene un tipo de contenido que este endpoint no acepta.",
  "status": 415,
  "code": "unsupported_media_type",
  "requestId": "request_000000000000000000000001"
}

Campos y códigos de la respuesta

Detalles de problema RFC 9457. Cada fallo de esta API es uno de estos objetos y cada operación limita code al subconjunto que puede emitir.

object

code

obligatorio

Código estable legible por máquinas. Toma decisiones con este código, nunca con title.

string

Valores permitidos: unsupported_media_type

requestId

obligatorio

string

status

obligatorio

integer format: int32

>= 400 <= 599

Valor permitido: 415

title

obligatorio

string

type

obligatorio

string

Valores permitidos: about:blank

Campos opcionales

detail

string

invoiceId

Solo aparece si la solicitud rechazada produjo una operación fiscal.

string

issuanceBlockers

Solo aparece cuando las reglas oficiales de emisión rechazan la emisión.

Array<string>

problems

Solo aparece cuando el rechazo señala un valor incluido en la solicitud.

Array<object>

Un problema público estable del documento, guardado para una admisión rechazada.

object

code

obligatorio

string

message

obligatorio

string

path

obligatorio

string

Cabeceras

request-id

obligatorio

string

Identifica esta solicitud. Indícalo cuando contactes a soporte.

500

La solicitud no pudo completarse. Recupera el resultado con la referencia guardada o repite la solicitud con la misma clave de idempotencia.

application/problem+json

Ejemplo

{
  "type": "about:blank",
  "title": "La solicitud no pudo completarse. Recupera el resultado con la referencia guardada o repite la solicitud con la misma clave de idempotencia.",
  "status": 500,
  "code": "internal_error",
  "requestId": "request_000000000000000000000001"
}

Campos y códigos de la respuesta

Detalles de problema RFC 9457. Cada fallo de esta API es uno de estos objetos y cada operación limita code al subconjunto que puede emitir.

object

code

obligatorio

Código estable legible por máquinas. Toma decisiones con este código, nunca con title.

string

Valores permitidos: internal_error

requestId

obligatorio

string

status

obligatorio

integer format: int32

>= 400 <= 599

Valor permitido: 500

title

obligatorio

string

type

obligatorio

string

Valores permitidos: about:blank

Campos opcionales

detail

string

invoiceId

Solo aparece si la solicitud rechazada produjo una operación fiscal.

string

issuanceBlockers

Solo aparece cuando las reglas oficiales de emisión rechazan la emisión.

Array<string>

problems

Solo aparece cuando el rechazo señala un valor incluido en la solicitud.

Array<object>

Un problema público estable del documento, guardado para una admisión rechazada.

object

code

obligatorio

string

message

obligatorio

string

path

obligatorio

string

Cabeceras

request-id

obligatorio

string

Identifica esta solicitud. Indícalo cuando contactes a soporte.

503

Un servicio requerido no está disponible temporalmente. Inténtalo de nuevo con la misma referencia o la misma clave de idempotencia.

application/problem+json

Ejemplo

{
  "type": "about:blank",
  "title": "Un servicio requerido no está disponible temporalmente. Inténtalo de nuevo con la misma referencia o la misma clave de idempotencia.",
  "status": 503,
  "code": "business_location_catalog_unavailable",
  "requestId": "request_000000000000000000000001"
}

Campos y códigos de la respuesta

Detalles de problema RFC 9457. Cada fallo de esta API es uno de estos objetos y cada operación limita code al subconjunto que puede emitir.

object

code

obligatorio

Código estable legible por máquinas. Toma decisiones con este código, nunca con title.

string

Valores permitidos: business_location_catalog_unavailable

requestId

obligatorio

string

status

obligatorio

integer format: int32

>= 400 <= 599

Valor permitido: 503

title

obligatorio

string

type

obligatorio

string

Valores permitidos: about:blank

Campos opcionales

detail

string

invoiceId

Solo aparece si la solicitud rechazada produjo una operación fiscal.

string

issuanceBlockers

Solo aparece cuando las reglas oficiales de emisión rechazan la emisión.

Array<string>

problems

Solo aparece cuando el rechazo señala un valor incluido en la solicitud.

Array<object>

Un problema público estable del documento, guardado para una admisión rechazada.

object

code

obligatorio

string

message

obligatorio

string

path

obligatorio

string

Cabeceras

request-id

obligatorio

string

Identifica esta solicitud. Indícalo cuando contactes a soporte.

Actualizar el negocio

Autenticación

Cuerpo de la solicitudobligatorio

Respuestas

200

Cabeceras

400

Ejemplo

Cabeceras

401

Ejemplo

Cabeceras

403

Ejemplo

Cabeceras

404

Ejemplo

Cabeceras

409

Ejemplo

Cabeceras

413

Ejemplo

Cabeceras

415

Ejemplo

Cabeceras

500

Ejemplo

Cabeceras

503

Ejemplo

Cabeceras

Cuerpo de la solicitud^obligatorio