GetDocument

POST /Document/GetDocument

GetDocument

Request

application/json
text/json
application/xml
text/xml
application/x-www-form-urlencoded

Body

required

GlobalDocumentId uuidrequired

Id del documento en Gosocket

CountryDocumentId stringrequired

Identificador Pais del documento conocido tambien como CUFE, CLAVE, UUID, ID

ExternalId stringrequired

Id del documento en sistema externo, el campo se extrae de xpath personalizado al llegar el documento

Country stringrequired

Codigo Pais, Ejemplos: cr,cl,py,uy,co,br,us,mx,ec,pe

DateFrom date-timerequired

Fecha de emision (desde), no se permite en el rango combinar 2 o mas años [*Campo obligatorio]

DateTo date-timerequired

Fecha de emision (hasta), no se permite en el rango combinar 2 o mas años [*Campo obligatorio]

LastChangeFrom date-timerequired

LastChangeTo date-timerequired

ReceivedDateFrom date-timerequired

Fecha de recepcion (desde)

ReceivedDateTo date-timerequired

Fecha de recepcion (hasta)

SenderCode stringrequired

TaxId Emisor

ReceiverCode stringrequired

TaxId Receptor

DocumentTypeId int32required

Numero con Tipo de documento

Series stringrequired

Serie del documento

Number stringrequired

Folio

TwoCheckStatusSender int32[]required

Estados del emisor con validaciones adicionales SmartSupply

TwoCheckStatusReceiver int32[]required

Estados del receptor con validaciones adicionales SmartSupply

DocumentTagValues object

Posibles Tags del documento, cada Tag define un estado, Ejemplo tag ACD con valor A es documento aprobado por el receptor

property name* stringrequired

ContainDocumentTagCode object

property name* booleanrequired

ResultMaxItemCount int32required

Cantidad de resultados de la consulta, si se pone un valor por encima de 100 el sistema lo ajustara a 100 maximo.

ContinuationToken stringrequired

ContinuationToken para paginar el resultado en caso de no responder todos en la consulta anterior

Responses

application/json
text/json
application/xml
text/xml

Schema
Example (from schema)

Schema

Array [

GlobalDocumentId uuidrequired

Id del documento en Gosocket

CountryDocumentId stringrequired

Id del documento en el Pais, ejemplo CUFE, Clave, UUID, ID

ExternalId stringrequired

Id del documento en el sistema externo, ejemplo Internal Number

CountryId stringrequired

Pais donde se emitio el documento

Date date-timerequired

Fecha Emision

DocumentTypeId int32required

Id del tipo de documento en Gosocket

DocumentTypeName stringrequired

Nombre del tipo de documento en Gosocket

NetAmount doublerequired

NetAmount

FreeAmount doublerequired

FreeAmount

TaxAmount doublerequired

FreeAmount

TotalAmount doublerequired

TotalAmount

CurrencyType stringrequired

Tipo Moneda

SeriesNumber stringrequired

Serie concatenado con Numero o folio

Series stringrequired

Serie

Number int64required

Numero o Folio formato numerico

NumberStr stringrequired

Numero o Folio formato string

DocumentSenderCode stringrequired

TaxId emisor

DocumentSenderName stringrequired

Nombre emisor

DocumentReceiverCode stringrequired

TaxId Receptor

DocumentReceiverName stringrequired

Nombre Receptor

DocumentFinancialOwnerCode stringrequired

DocumentFinancialOwnerName stringrequired

FinancialDate date-timerequired

DocumentTimeStamp date-timerequired

Fecha Recepcion en Gosocket

AuthorityTimeStamp date-timerequired

SyncPoint uuidrequired

Syncpoint o Usuario del sistema que envio el documento a Gosocket

DocumentTags DocumentTag[]

Posibles Tags del documento, cada Tag define un estado, Ejemplo tag ACD con valor A es documento aprobado por el receptor

Array [

Code stringrequired

Codigo del tag Ej (ACD)(AttSC)(AttRC)

TimeStamp date-timerequired

Fecha y hora del ultimo cambio de estado

Value stringrequired

Valor del tag

]

TwoCheck TwoChekResult

Estados del receptor con validaciones adicionales SmartSupply

TwoCheckDocumentStatus int32required

TwoCheckDocumentStatusDescription stringrequired

TwoCheckReceiverDocumentStatus int32required

TwoCheckReceiverInternalDocumentStatusDescription stringrequired

Timestamp date-timerequired

Fecha y hora del ultimo cambio de estado twoCheck

Notes DocumentNotes[]

Array [

Mandatory booleanrequired

Code stringrequired

Note stringrequired

TimeStamp date-timerequired

Source stringrequired

]

]

[
  {
    "GlobalDocumentId": "00000000-0000-0000-0000-000000000000",
    "CountryDocumentId": "string",
    "ExternalId": "string",
    "CountryId": "string",
    "Date": "2024-04-02T21:01:32.381Z",
    "DocumentTypeId": 0,
    "DocumentTypeName": "string",
    "NetAmount": 0,
    "FreeAmount": 0,
    "TaxAmount": 0,
    "TotalAmount": 0,
    "CurrencyType": "string",
    "SeriesNumber": "string",
    "Series": "string",
    "Number": 0,
    "NumberStr": "string",
    "DocumentSenderCode": "string",
    "DocumentSenderName": "string",
    "DocumentReceiverCode": "string",
    "DocumentReceiverName": "string",
    "DocumentFinancialOwnerCode": "string",
    "DocumentFinancialOwnerName": "string",
    "FinancialDate": "2024-04-02T21:01:32.382Z",
    "DocumentTimeStamp": "2024-04-02T21:01:32.382Z",
    "AuthorityTimeStamp": "2024-04-02T21:01:32.382Z",
    "SyncPoint": "00000000-0000-0000-0000-000000000000",
    "DocumentTags": [
      {
        "Code": "string",
        "TimeStamp": "2024-04-02T21:01:32.382Z",
        "Value": "string"
      }
    ],
    "TwoCheck": {
      "TwoCheckDocumentStatus": 0,
      "TwoCheckDocumentStatusDescription": "string",
      "TwoCheckReceiverDocumentStatus": 0,
      "TwoCheckReceiverInternalDocumentStatusDescription": "string",
      "Timestamp": "2024-04-02T21:01:32.382Z"
    },
    "Notes": [
      {
        "Mandatory": true,
        "Code": "string",
        "Note": "string",
        "TimeStamp": "2024-04-02T21:01:32.382Z",
        "Source": "string"
      }
    ]
  }
]

Schema
Example (from schema)

Schema

Array [

GlobalDocumentId uuidrequired

Id del documento en Gosocket

CountryDocumentId stringrequired

Id del documento en el Pais, ejemplo CUFE, Clave, UUID, ID

ExternalId stringrequired

Id del documento en el sistema externo, ejemplo Internal Number

CountryId stringrequired

Pais donde se emitio el documento

Date date-timerequired

Fecha Emision

DocumentTypeId int32required

Id del tipo de documento en Gosocket

DocumentTypeName stringrequired

Nombre del tipo de documento en Gosocket

NetAmount doublerequired

NetAmount

FreeAmount doublerequired

FreeAmount

TaxAmount doublerequired

FreeAmount

TotalAmount doublerequired

TotalAmount

CurrencyType stringrequired

Tipo Moneda

SeriesNumber stringrequired

Serie concatenado con Numero o folio

Series stringrequired

Serie

Number int64required

Numero o Folio formato numerico

NumberStr stringrequired

Numero o Folio formato string

DocumentSenderCode stringrequired

TaxId emisor

DocumentSenderName stringrequired

Nombre emisor

DocumentReceiverCode stringrequired

TaxId Receptor

DocumentReceiverName stringrequired

Nombre Receptor

DocumentFinancialOwnerCode stringrequired

DocumentFinancialOwnerName stringrequired

FinancialDate date-timerequired

DocumentTimeStamp date-timerequired

Fecha Recepcion en Gosocket

AuthorityTimeStamp date-timerequired

SyncPoint uuidrequired

Syncpoint o Usuario del sistema que envio el documento a Gosocket

DocumentTags DocumentTag[]

Posibles Tags del documento, cada Tag define un estado, Ejemplo tag ACD con valor A es documento aprobado por el receptor

Array [

Code stringrequired

Codigo del tag Ej (ACD)(AttSC)(AttRC)

TimeStamp date-timerequired

Fecha y hora del ultimo cambio de estado

Value stringrequired

Valor del tag

]

TwoCheck TwoChekResult

Estados del receptor con validaciones adicionales SmartSupply

TwoCheckDocumentStatus int32required

TwoCheckDocumentStatusDescription stringrequired

TwoCheckReceiverDocumentStatus int32required

TwoCheckReceiverInternalDocumentStatusDescription stringrequired

Timestamp date-timerequired

Fecha y hora del ultimo cambio de estado twoCheck

Notes DocumentNotes[]

Array [

Mandatory booleanrequired

Code stringrequired

Note stringrequired

TimeStamp date-timerequired

Source stringrequired

]

]

[
  {
    "GlobalDocumentId": "00000000-0000-0000-0000-000000000000",
    "CountryDocumentId": "string",
    "ExternalId": "string",
    "CountryId": "string",
    "Date": "2024-04-02T21:01:32.382Z",
    "DocumentTypeId": 0,
    "DocumentTypeName": "string",
    "NetAmount": 0,
    "FreeAmount": 0,
    "TaxAmount": 0,
    "TotalAmount": 0,
    "CurrencyType": "string",
    "SeriesNumber": "string",
    "Series": "string",
    "Number": 0,
    "NumberStr": "string",
    "DocumentSenderCode": "string",
    "DocumentSenderName": "string",
    "DocumentReceiverCode": "string",
    "DocumentReceiverName": "string",
    "DocumentFinancialOwnerCode": "string",
    "DocumentFinancialOwnerName": "string",
    "FinancialDate": "2024-04-02T21:01:32.382Z",
    "DocumentTimeStamp": "2024-04-02T21:01:32.382Z",
    "AuthorityTimeStamp": "2024-04-02T21:01:32.382Z",
    "SyncPoint": "00000000-0000-0000-0000-000000000000",
    "DocumentTags": [
      {
        "Code": "string",
        "TimeStamp": "2024-04-02T21:01:32.382Z",
        "Value": "string"
      }
    ],
    "TwoCheck": {
      "TwoCheckDocumentStatus": 0,
      "TwoCheckDocumentStatusDescription": "string",
      "TwoCheckReceiverDocumentStatus": 0,
      "TwoCheckReceiverInternalDocumentStatusDescription": "string",
      "Timestamp": "2024-04-02T21:01:32.382Z"
    },
    "Notes": [
      {
        "Mandatory": true,
        "Code": "string",
        "Note": "string",
        "TimeStamp": "2024-04-02T21:01:32.382Z",
        "Source": "string"
      }
    ]
  }
]

Schema
Example (from schema)

Schema

Array [

GlobalDocumentId uuidrequired

Id del documento en Gosocket

CountryDocumentId stringrequired

Id del documento en el Pais, ejemplo CUFE, Clave, UUID, ID

ExternalId stringrequired

Id del documento en el sistema externo, ejemplo Internal Number

CountryId stringrequired

Pais donde se emitio el documento

Date date-timerequired

Fecha Emision

DocumentTypeId int32required

Id del tipo de documento en Gosocket

DocumentTypeName stringrequired

Nombre del tipo de documento en Gosocket

NetAmount doublerequired

NetAmount

FreeAmount doublerequired

FreeAmount

TaxAmount doublerequired

FreeAmount

TotalAmount doublerequired

TotalAmount

CurrencyType stringrequired

Tipo Moneda

SeriesNumber stringrequired

Serie concatenado con Numero o folio

Series stringrequired

Serie

Number int64required

Numero o Folio formato numerico

NumberStr stringrequired

Numero o Folio formato string

DocumentSenderCode stringrequired

TaxId emisor

DocumentSenderName stringrequired

Nombre emisor

DocumentReceiverCode stringrequired

TaxId Receptor

DocumentReceiverName stringrequired

Nombre Receptor

DocumentFinancialOwnerCode stringrequired

DocumentFinancialOwnerName stringrequired

FinancialDate date-timerequired

DocumentTimeStamp date-timerequired

Fecha Recepcion en Gosocket

AuthorityTimeStamp date-timerequired

SyncPoint uuidrequired

Syncpoint o Usuario del sistema que envio el documento a Gosocket

DocumentTags DocumentTag[]

Posibles Tags del documento, cada Tag define un estado, Ejemplo tag ACD con valor A es documento aprobado por el receptor

Array [

Code stringrequired

Codigo del tag Ej (ACD)(AttSC)(AttRC)

TimeStamp date-timerequired

Fecha y hora del ultimo cambio de estado

Value stringrequired

Valor del tag

]

TwoCheck TwoChekResult

Estados del receptor con validaciones adicionales SmartSupply

TwoCheckDocumentStatus int32required

TwoCheckDocumentStatusDescription stringrequired

TwoCheckReceiverDocumentStatus int32required

TwoCheckReceiverInternalDocumentStatusDescription stringrequired

Timestamp date-timerequired

Fecha y hora del ultimo cambio de estado twoCheck

Notes DocumentNotes[]

Array [

Mandatory booleanrequired

Code stringrequired

Note stringrequired

TimeStamp date-timerequired

Source stringrequired

]

]

<0>
  <GlobalDocumentId>00000000-0000-0000-0000-000000000000</GlobalDocumentId>
  <CountryDocumentId>string</CountryDocumentId>
  <ExternalId>string</ExternalId>
  <CountryId>string</CountryId>
  <Date>2024-04-02T21:01:32.383Z</Date>
  <DocumentTypeId>0</DocumentTypeId>
  <DocumentTypeName>string</DocumentTypeName>
  <NetAmount>0</NetAmount>
  <FreeAmount>0</FreeAmount>
  <TaxAmount>0</TaxAmount>
  <TotalAmount>0</TotalAmount>
  <CurrencyType>string</CurrencyType>
  <SeriesNumber>string</SeriesNumber>
  <Series>string</Series>
  <Number>0</Number>
  <NumberStr>string</NumberStr>
  <DocumentSenderCode>string</DocumentSenderCode>
  <DocumentSenderName>string</DocumentSenderName>
  <DocumentReceiverCode>string</DocumentReceiverCode>
  <DocumentReceiverName>string</DocumentReceiverName>
  <DocumentFinancialOwnerCode>string</DocumentFinancialOwnerCode>
  <DocumentFinancialOwnerName>string</DocumentFinancialOwnerName>
  <FinancialDate>2024-04-02T21:01:32.383Z</FinancialDate>
  <DocumentTimeStamp>2024-04-02T21:01:32.383Z</DocumentTimeStamp>
  <AuthorityTimeStamp>2024-04-02T21:01:32.383Z</AuthorityTimeStamp>
  <SyncPoint>00000000-0000-0000-0000-000000000000</SyncPoint>
  <DocumentTags>
    <Code>string</Code>
    <TimeStamp>2024-04-02T21:01:32.383Z</TimeStamp>
    <Value>string</Value>
  </DocumentTags>
  <TwoCheck>
    <TwoCheckDocumentStatus>0</TwoCheckDocumentStatus>
    <TwoCheckDocumentStatusDescription>string</TwoCheckDocumentStatusDescription>
    <TwoCheckReceiverDocumentStatus>0</TwoCheckReceiverDocumentStatus>
    <TwoCheckReceiverInternalDocumentStatusDescription>string</TwoCheckReceiverInternalDocumentStatusDescription>
    <Timestamp>2024-04-02T21:01:32.383Z</Timestamp>
  </TwoCheck>
  <Notes>
    <Mandatory>true</Mandatory>
    <Code>string</Code>
    <Note>string</Note>
    <TimeStamp>2024-04-02T21:01:32.383Z</TimeStamp>
    <Source>string</Source>
  </Notes>
</0>

Schema
Example (from schema)

Schema

Array [

GlobalDocumentId uuidrequired

Id del documento en Gosocket

CountryDocumentId stringrequired

Id del documento en el Pais, ejemplo CUFE, Clave, UUID, ID

ExternalId stringrequired

Id del documento en el sistema externo, ejemplo Internal Number

CountryId stringrequired

Pais donde se emitio el documento

Date date-timerequired

Fecha Emision

DocumentTypeId int32required

Id del tipo de documento en Gosocket

DocumentTypeName stringrequired

Nombre del tipo de documento en Gosocket

NetAmount doublerequired

NetAmount

FreeAmount doublerequired

FreeAmount

TaxAmount doublerequired

FreeAmount

TotalAmount doublerequired

TotalAmount

CurrencyType stringrequired

Tipo Moneda

SeriesNumber stringrequired

Serie concatenado con Numero o folio

Series stringrequired

Serie

Number int64required

Numero o Folio formato numerico

NumberStr stringrequired

Numero o Folio formato string

DocumentSenderCode stringrequired

TaxId emisor

DocumentSenderName stringrequired

Nombre emisor

DocumentReceiverCode stringrequired

TaxId Receptor

DocumentReceiverName stringrequired

Nombre Receptor

DocumentFinancialOwnerCode stringrequired

DocumentFinancialOwnerName stringrequired

FinancialDate date-timerequired

DocumentTimeStamp date-timerequired

Fecha Recepcion en Gosocket

AuthorityTimeStamp date-timerequired

SyncPoint uuidrequired

Syncpoint o Usuario del sistema que envio el documento a Gosocket

DocumentTags DocumentTag[]

Posibles Tags del documento, cada Tag define un estado, Ejemplo tag ACD con valor A es documento aprobado por el receptor

Array [

Code stringrequired

Codigo del tag Ej (ACD)(AttSC)(AttRC)

TimeStamp date-timerequired

Fecha y hora del ultimo cambio de estado

Value stringrequired

Valor del tag

]

TwoCheck TwoChekResult

Estados del receptor con validaciones adicionales SmartSupply

TwoCheckDocumentStatus int32required

TwoCheckDocumentStatusDescription stringrequired

TwoCheckReceiverDocumentStatus int32required

TwoCheckReceiverInternalDocumentStatusDescription stringrequired

Timestamp date-timerequired

Fecha y hora del ultimo cambio de estado twoCheck

Notes DocumentNotes[]

Array [

Mandatory booleanrequired

Code stringrequired

Note stringrequired

TimeStamp date-timerequired

Source stringrequired

]

]

<0>
  <GlobalDocumentId>00000000-0000-0000-0000-000000000000</GlobalDocumentId>
  <CountryDocumentId>string</CountryDocumentId>
  <ExternalId>string</ExternalId>
  <CountryId>string</CountryId>
  <Date>2024-04-02T21:01:32.383Z</Date>
  <DocumentTypeId>0</DocumentTypeId>
  <DocumentTypeName>string</DocumentTypeName>
  <NetAmount>0</NetAmount>
  <FreeAmount>0</FreeAmount>
  <TaxAmount>0</TaxAmount>
  <TotalAmount>0</TotalAmount>
  <CurrencyType>string</CurrencyType>
  <SeriesNumber>string</SeriesNumber>
  <Series>string</Series>
  <Number>0</Number>
  <NumberStr>string</NumberStr>
  <DocumentSenderCode>string</DocumentSenderCode>
  <DocumentSenderName>string</DocumentSenderName>
  <DocumentReceiverCode>string</DocumentReceiverCode>
  <DocumentReceiverName>string</DocumentReceiverName>
  <DocumentFinancialOwnerCode>string</DocumentFinancialOwnerCode>
  <DocumentFinancialOwnerName>string</DocumentFinancialOwnerName>
  <FinancialDate>2024-04-02T21:01:32.383Z</FinancialDate>
  <DocumentTimeStamp>2024-04-02T21:01:32.383Z</DocumentTimeStamp>
  <AuthorityTimeStamp>2024-04-02T21:01:32.383Z</AuthorityTimeStamp>
  <SyncPoint>00000000-0000-0000-0000-000000000000</SyncPoint>
  <DocumentTags>
    <Code>string</Code>
    <TimeStamp>2024-04-02T21:01:32.383Z</TimeStamp>
    <Value>string</Value>
  </DocumentTags>
  <TwoCheck>
    <TwoCheckDocumentStatus>0</TwoCheckDocumentStatus>
    <TwoCheckDocumentStatusDescription>string</TwoCheckDocumentStatusDescription>
    <TwoCheckReceiverDocumentStatus>0</TwoCheckReceiverDocumentStatus>
    <TwoCheckReceiverInternalDocumentStatusDescription>string</TwoCheckReceiverInternalDocumentStatusDescription>
    <Timestamp>2024-04-02T21:01:32.383Z</Timestamp>
  </TwoCheck>
  <Notes>
    <Mandatory>true</Mandatory>
    <Code>string</Code>
    <Note>string</Note>
    <TimeStamp>2024-04-02T21:01:32.383Z</TimeStamp>
    <Source>string</Source>
  </Notes>
</0>

GetDocument

/Document/GetDocument

Request​

Body

Body

Body

Body

Body

Responses​

Request

Responses