Register delivery integration

HOM

https://hom.roit.ai

POST

/ibs-core-delivery/api/v1/delivery

Request

Header Params

Body Params application/jsonRequired

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",
                    "metadata": [
                        {
                            "key": "customField1",
                            "value": "valor1"
                        },
                        {
                            "key": "customField2",
                            "value": "valor2"
                        }
                    ]
                }
            ],
            "payment": {
                "method": "PIX",
                "condition": "001"
            },
            "requester": "THOMAS EDISON",
            "approver": "SANTOS DUMONT",
            "canceled": "false",
            "status": "APPROVED",
            "initialValue": 5000,
            "totalValue": 4000
        }
    ]
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

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",
                    "metadata": [
                        {
                            "key": "customField1",
                            "value": "valor1"
                        },
                        {
                            "key": "customField2",
                            "value": "valor2"
                        }
                    ]
                }
            ],
            "payment": {
                "method": "PIX",
                "condition": "001"
            },
            "requester": "THOMAS EDISON",
            "approver": "SANTOS DUMONT",
            "canceled": "false",
            "status": "APPROVED",
            "initialValue": 5000,
            "totalValue": 4000
        }
    ]
}'

Responses

🟢201Created

application/json

Success response

Body

Example

{
    "timestamp": 1672531200,
    "status": "success",
    "message": "Request received successfully"
}

🟠400Bad Request

🟠401Unauthorized

Modified at 2026-01-30 19:38:59

Get pending entities to be integrated

Update integration status