PUBLIC SERVICES [PROD]
  1. External System Integration
PUBLIC SERVICES [PROD]
  • Introduction
  • Document Management
  • External Integration
  • Authentication
    • Generate a token to access ROIT APIs
      POST
  • Invoice-to-Pay
    • Documents Manager
      • Create document export request
      • Get export request by id
      • Delete export request by id
      • Generate signed URLs for export files by id
    • External System Integration
      • Get pending entities to be integrated
        POST
      • Register delivery integration
        POST
      • Update integration status
        POST
      • Get all documents attached to a request
        POST
    • Upload Document
      • Upload document as base64
  • Tax Reform
    • Data Integration
      • Create Request
      • Update Request Status
      • Generate Signed Url
  • External System Integration
    • Reprocess a specific request
      POST
  1. External System Integration

Register delivery integration

HOM
HOM
POST
/ibs-core-delivery/api/v1/delivery
delivery

Request

Header Params
Authorization
string 
required
token generated
Body Params application/json
isDefault
boolean 
optional
Attribute to define if the translation to be used is the default one
Default:
false
Example:
false
integrationId
string 
required
Integration id that will be used to integrate the data into the system
Example:
INT123456
entity
enum<string> 
required
Entity that will be used to integrate the data into the system. Attention: CUSTOM entity accepts any field structure, for successful integration, prior planning and configuration for the sended data is required, otherwise the integration will fail.
Allowed values:
DOCUMENTACCOUNTS_PAYABLE_EXTERNALPURCHASE_ORDERSERVICE_ORDERUMBRELLA_AGREEMENTSUPPLIERTAX_CODETAX_CODE_IRFCUSTOMDELIVERY_AUTHORIZATIONCOST_CENTERITEMPAYMENT_CONDITIONOUTBOUND_INVOICEFINANCIAL_NATUREBLIND_REVIEWGOODS_THIRD_PARTY
Example:
SUPPLIER
subEntity
string 
optional
Sub-entity for CUSTOM entity
Example:
SUBENTITY_EXAMPLE
data
array [oneOf] 
required
Dynamic object that contains data to be integrated. Attention: CUSTOM entity accepts any field structure, for successful integration, prior planning and configuration for the sended data is required, otherwise the integration will fail.
object 
PurchaseOrderDto
optional
object 
SupplierDto
optional
object 
AccountsPayableDto
optional
object 
TaxCodeDto
optional
object 
TaxCodeIrfDto
optional
object 
DeliveryAuthorizationDto
optional
object 
CostCenterDto
optional
object 
PaymentConditionDto
optional
object 
ItemDto
optional
object 
FinancialNatureDto
optional
object 
OutboundInvoiceDto
optional
object 
BlindReviewDto
optional
object 
GoodsThirdPartyDto
optional
Examples
Purchase Order example
{
  "isDefault": true,
  "integrationId": "12345",
  "entity": "PURCHASE_ORDER",
  "data": [
    {
      "purchaseNumber": "qa1221231",
      "beneficiary": {
        "code": "00000101",
        "name": "ACME CORP INC",
        "nationalRegister": "00111222000100"
      },
      "provider": {
        "code": "00000101",
        "name": "ACME CORP INC",
        "nationalRegister": "00111222000100"
      },
      "invoiceNature": "010101010",
      "documentDate": "2024-12-31T00:00:00:SSZ",
      "deliveryDate": "2024-12-31T00:00:00:SSZ",
      "items": [
        {
          "itemCode": "P01212110",
          "orderItem": "0001",
          "description": "PRODUCT FAKE EXAMPLE",
          "ncm": "45214410",
          "unitMeasure": "UN",
          "costCenter": "10102030",
          "serviceCode": "1401",
          "initialValueItem": 5000,
          "unitValue": 100,
          "totalValue": 4000,
          "quantity": 40,
          "initialQuantityItem": 50,
          "accountInfo": "14123100123"
        }
      ],
      "payment": {
        "method": "PIX",
        "condition": "001"
      },
      "requester": "THOMAS EDISON",
      "approver": "SANTOS DUMONT",
      "canceled": "false",
      "status": "APPROVED",
      "initialValue": 5000,
      "totalValue": 4000,
      "custom": {
        "campoPersonalizado1": "valor1",
        "campoPersonalizado2": "valor2"
      }
    }
  ]
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
cURL
curl --location --request POST 'https://hom.roit.ai/ibs-core-delivery/api/v1/delivery' \
--header 'Authorization;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "isDefault": true,
    "integrationId": "12345",
    "entity": "PURCHASE_ORDER",
    "data": [
        {
            "purchaseNumber": "qa1221231",
            "beneficiary": {
                "code": "00000101",
                "name": "ACME CORP INC",
                "nationalRegister": "00111222000100"
            },
            "provider": {
                "code": "00000101",
                "name": "ACME CORP INC",
                "nationalRegister": "00111222000100"
            },
            "invoiceNature": "010101010",
            "documentDate": "2024-12-31T00:00:00:SSZ",
            "deliveryDate": "2024-12-31T00:00:00:SSZ",
            "items": [
                {
                    "itemCode": "P01212110",
                    "orderItem": "0001",
                    "description": "PRODUCT FAKE EXAMPLE",
                    "ncm": "45214410",
                    "unitMeasure": "UN",
                    "costCenter": "10102030",
                    "serviceCode": "1401",
                    "initialValueItem": 5000,
                    "unitValue": 100,
                    "totalValue": 4000,
                    "quantity": 40,
                    "initialQuantityItem": 50,
                    "accountInfo": "14123100123"
                }
            ],
            "payment": {
                "method": "PIX",
                "condition": "001"
            },
            "requester": "THOMAS EDISON",
            "approver": "SANTOS DUMONT",
            "canceled": "false",
            "status": "APPROVED",
            "initialValue": 5000,
            "totalValue": 4000,
            "custom": {
                "campoPersonalizado1": "valor1",
                "campoPersonalizado2": "valor2"
            }
        }
    ]
}'

Responses

🟢201Created
application/json
Success response
Body
timestamp
number 
required
Timestamp of the response
Example:
1672531200
status
string 
required
Status of the response
Example:
success
message
string 
required
Message status
Example:
Request received successfully
Example
{
  "timestamp": 1672531200,
  "status": "success",
  "message": "Request received successfully"
}
🟠400Bad Request
🟠401Unauthorized
Modified at 2025-04-25 18:47:14
Previous
Get pending entities to be integrated
Next
Update integration status
Built with