Skip to main content
GET
/
documents
/
{document_id}
Get Document
curl --request GET \
  --url http://localhost:8000/documents/{document_id}
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "tenant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "issuer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "establishment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "emission_point_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "document_type": "<string>",
  "sequential": 123,
  "access_key": "<string>",
  "status": "<string>",
  "idempotency_key": "<string>",
  "issue_date": "2023-12-25",
  "subtotal": "<string>",
  "total_discount": "<string>",
  "total_tax": "<string>",
  "total": "<string>",
  "buyer_id_type": "<string>",
  "buyer_id": "<string>",
  "buyer_name": "<string>",
  "buyer_email": "<string>",
  "buyer_address": "<string>",
  "modified_document_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "modified_document_type": "<string>",
  "modified_document_number": "<string>",
  "modified_document_issue_date": "2023-12-25",
  "reason": "<string>",
  "authorization_number": "<string>",
  "authorization_date": "2023-11-07T05:31:56Z",
  "sri_environment": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "available_actions": {
    "can_edit": true,
    "can_submit": true,
    "can_cancel": true,
    "can_retry": true,
    "can_reconcile": true,
    "can_mark_failed": true,
    "can_resend_email": true,
    "can_create_credit_note": true
  },
  "cancellation_info": {
    "requested_at": "2023-11-07T05:31:56Z",
    "reason": "<string>",
    "cancelled_at": "2023-11-07T05:31:56Z"
  },
  "artifacts": {
    "xml_url": "<string>",
    "pdf_url": "<string>",
    "ride_url": "<string>"
  },
  "sri_response": {
    "reception_state": "<string>",
    "authorization_state": "<string>",
    "authorization_number": "<string>",
    "authorization_date": "2023-11-07T05:31:56Z",
    "messages": [
      {
        "identifier": "<string>",
        "message": "<string>",
        "additional_info": "<string>",
        "message_type": "<string>"
      }
    ]
  },
  "job_status": {
    "last_attempt_at": "2023-11-07T05:31:56Z",
    "next_retry_at": "2023-11-07T05:31:56Z",
    "attempt_count": 123,
    "worker_id": "<string>"
  },
  "related_documents": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "document_type": "<string>",
      "sequential": 123,
      "access_key": "<string>",
      "status": "<string>",
      "relationship": "<string>"
    }
  ],
  "status_history": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "previous_status": "<string>",
      "new_status": "<string>",
      "changed_by_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "changed_by_worker_id": "<string>",
      "detail": "<string>",
      "created_at": "2023-11-07T05:31:56Z"
    }
  ],
  "lines": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "line_number": 123,
      "description": "<string>",
      "main_code": "<string>",
      "aux_code": "<string>",
      "quantity": "<string>",
      "unit_price": "<string>",
      "discount": "<string>",
      "subtotal": "<string>",
      "tax_code": "<string>",
      "tax_rate_code": "<string>"
    }
  ],
  "taxes": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "tax_code": "<string>",
      "tax_rate_code": "<string>",
      "taxable_base": "<string>",
      "rate": "<string>",
      "tax_amount": "<string>"
    }
  ],
  "payments": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "line_number": 123,
      "payment_method_code": "<string>",
      "total": "<string>",
      "term": 123,
      "time_unit": "<string>"
    }
  ]
}

Headers

authorization
string | null
x-api-key
string | null
x-tenant-id
string | null

Path Parameters

document_id
string<uuid>
required

Cookies

factio_access_token
string | null

Response

Successful Response

id
string<uuid>
required
tenant_id
string<uuid>
required
issuer_id
string<uuid>
required
establishment_id
string<uuid>
required
emission_point_id
string<uuid>
required
document_type
string
required
sequential
integer | null
required
access_key
string | null
required
status
string
required
idempotency_key
string | null
required
issue_date
string<date>
required
subtotal
string
required
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
total_discount
string
required
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
total_tax
string
required
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
total
string
required
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
buyer_id_type
string | null
required
buyer_id
string | null
required
buyer_name
string | null
required
buyer_email
string | null
required
buyer_address
string | null
required
modified_document_id
string<uuid> | null
required
modified_document_type
string | null
required
modified_document_number
string | null
required
modified_document_issue_date
string<date> | null
required
reason
string | null
required
authorization_number
string | null
required
authorization_date
string<date-time> | null
required
sri_environment
string
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
available_actions
AvailableActionsSchema · object
required
cancellation_info
CancellationInfoSchema · object
required
artifacts
ArtifactsSchema · object
required
sri_response
SRIResponseSchema · object
required
job_status
JobStatusSchema · object
required
status_history
StatusHistoryEntrySchema · object[]
required
lines
DocumentLineResponse · object[]
required
taxes
DocumentTaxResponse · object[]
required
payments
DocumentPaymentResponse · object[]
required