Update integration status - PUBLIC SERVICES [PROD]

Request

Header Params

Authorization

string

required

token generated

Body Params application/json

status

enum<string>

required

Status of the operations

Allowed values:

PROCESSINGRECEIVEDPENDINGERRORDONEWARNING

Example:

DONE

reference

string

required

Reference used to register the request

Example:

abcd1234-ef56-gh78-ij90-klmnopqrstuv

message

string

required

Message describing the update

Example:

Document was successfully processed

requestId

string

required

ID of the request

Example:

1234a5b6-cd78-9012-3456-789e012345fg

integrationId

string

required

ID of the integration registered at ROIT ADMIN

Example:

9876c5d4-ba32-1098-7654-321f98765432

entryReference

number

optional

Number of the entry when the process was concluded with success

Example:

1234567890

entryDate

string

optional

Date of the entry on target system on ISO FORMAT when the process was concluded with success.

Example:

2024-01-01T01:01:01.000Z

systemInfo

object

optional

Info about the system that sent this update

Default:

{}

Example:

{"system":"ROIT ADMIN","version":"1.0.0","host":"localhost","port":3000}

metadata

object

optional

Custom data about the update

Default:

{}

Example:

{"customField":"customValue"}

Examples

updateStatusupdateStatusError

Update Status

{
    "status": "DONE",
    "reference": "abcd1234-ef56-gh78-ij90-klmnopqrstuv",
    "message": "Document was successfully processed",
    "requestId": "1234a5b6-cd78-9012-3456-789e012345fg",
    "integrationId": "9876c5d4-ba32-1098-7654-321f98765432",
    "entryReference": 1234567890,
    "entryDate": "2024-01-01T01:01:01.000Z",
    "systemInfo": {
        "system": "ROIT ADMIN",
        "version": "1.0.0",
        "host": "localhost",
        "port": 3000
    },
    "metadata": {
        "customField": "customValue"
    }
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

cURL

updateStatusupdateStatusError

curl --location --request POST 'https://hom.roit.ai/ibs-core-entrypoint/api/v1/entrypoint/requests/status' \
--header 'Authorization;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "status": "DONE",
    "reference": "abcd1234-ef56-gh78-ij90-klmnopqrstuv",
    "message": "Document was successfully processed",
    "requestId": "1234a5b6-cd78-9012-3456-789e012345fg",
    "integrationId": "9876c5d4-ba32-1098-7654-321f98765432",
    "entryReference": 1234567890,
    "entryDate": "2024-01-01T01:01:01.000Z",
    "systemInfo": {
        "system": "ROIT ADMIN",
        "version": "1.0.0",
        "host": "localhost",
        "port": 3000
    },
    "metadata": {
        "customField": "customValue"
    }
}'

Responses

🟢201Created

application/json

Body

timestamp

number

optional

status

string

optional

message

string

optional

data

object (UpdateStatusResponseDto)

optional

id

string

optional

ID C:nico do status

Example:

550e8400-e29b-41d4-a716-446655440000

entity

enum<string>

required

Tipo da entidade

Allowed values:

DOCUMENTACCOUNTS_PAYABLEPURCHASE_ORDERERP_PARAMSSUPPLIERGENERICTAX_VALIDATIONDOCUMENT_REVERSESERVICE_ENTRY_SHEET

Example:

DOCUMENT

masterId

string

required

ID do master

Example:

MASTER001

requestId

string

required

ID da requisiC'C#o

Example:

REQ123456

reference

string

required

ReferC*ncia do documento

Example:

REF123456

integrationId

string

required

ID da integraC'C#o

Example:

INT001

type

string

required

Tipo do documento

Example:

NFE

status

enum<string>

required

Status da entrada

Allowed values:

PROCESSINGRECEIVEDPENDINGERRORDONEWARNING

Example:

DONE

isPriority

boolean

optional

Indica se C) prioritC!rio

Example:

false

retryAfter

number

required

Tempo de espera para retry em segundos

Example:

0

message

string

optional

Mensagem do status

Example:

Documento processado com sucesso

metadata

object

optional

Metadados adicionais

Example:

{"processId":"PROC123","priority":true,"retryCount":0}

entryReference

number

optional

ReferC*ncia da entrada

Example:

123456

entryDate

string

optional

Data da entrada

Example:

2024-03-28T10:00:00Z

systemInfo

object

optional

InformaC'C5es do sistema

Example:

{"programVersion":"1.0.0"}

Example

{
    "timestamp": 0,
    "status": "string",
    "message": "string",
    "data": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "entity": "DOCUMENT",
        "masterId": "MASTER001",
        "requestId": "REQ123456",
        "reference": "REF123456",
        "integrationId": "INT001",
        "type": "NFE",
        "status": "PROCESSING",
        "isPriority": false,
        "retryAfter": 0,
        "message": "Documento processado com sucesso",
        "metadata": {
            "processId": "PROC123",
            "priority": true,
            "retryCount": 0
        },
        "entryReference": 123456,
        "entryDate": "2024-03-28T10:00:00Z",
        "systemInfo": {
            "programVersion": "1.0.0"
        }
    }
}

🟠400Bad Request

🟠403Forbidden