PUBLIC SERVICES [PROD]
  1. Schemas
PUBLIC SERVICES [PROD]
  • Introduction
  • Document Management
  • External Integration
  • Authentication
    • Generate a token to access ROIT APIs
  • 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
      • Export structured document data processed in the Pipeline
    • External System Integration
      • Get pending entities to be integrated
      • Register delivery integration
      • Update integration status
      • Get all documents attached to a request
      • Reprocess a specific request
    • Upload Document
      • Upload document as base64
    • Account Payable
      • This operation will list the Account payable events
      • This operation will count all the Account payable
      • This operation will search the Account payable by id
      • This operation will search all the Account payable
      • This operations is designed to search an account payable by metadata information
  • Tax Reform
    • Data Integration
      • Create a new request
      • Update request status
      • Generate signed URL
    • CClasTrib Data
      • Get cclasstrib data
    • Data Sync
      • Sync data
  • Schemas
    • Schemas
      • Currency
      • UserContextModel
      • ForgotPasswordDTO
      • nationalRegisterGeneric
      • ProcessUpload
      • NationalRegisterGeneric
      • CompanyDTO
      • DocumentFileDTO
      • Date
      • Period
      • TransitionalTokenResponseDTO
      • AddresGeneric
      • InstallmentDetailsModel
      • DocumentFileErpDTO
      • HeaderModel
      • QueryOperatorFormat
      • LoginDTO
      • ProviderGeneric
      • FileUploadBase64DTO
      • CurrencyDTO
      • DocumentAddressDTO
      • LinkModel
      • QueryOperators
      • CustomTokenResponseDTO
      • NfeModalityDto
      • AccountsPayableHeaderDto
      • ValueDTO
      • DocumentPartyDTO
      • CostCenter
      • QueryOperatorStep
      • RefreshTokenResponseDTO
      • NfeDocumentHeaderDto
      • HolderDto
      • AccountPayableMetadataDTO
      • DocumentServiceDTO
      • ItemParentModel
      • ClientTreeFilter
      • RefreshTokenDTO
      • NfeTaxDto
      • CostCenterGeneric
      • ReceiptModel
      • DocumentCpomDTO
      • Tribute
      • BaseFiltersModel
      • AuthorizationTokenResponseDTO
      • costCenterGeneric
      • CreateRequestSuccessResponse
      • AccountsPayableResponseDto
      • CanceledAccountPayableUser
      • DocumentTributeDTO
      • ItemModel
      • ExportRequestModel
      • UserInfoDTO
      • NfeItemDto
      • GenericErrorResponse
      • AccountsPayableModelResponse
      • CanceledAccountPayable
      • DocumentTransportDTO
      • ServiceLocation
      • CreateRequestDTO
      • CreateTokenDTO
      • NfeDto
      • GenericUnauthorizedResponse
      • Status
      • PaymentPurpose
      • DocumentPaymentDTO
      • TaxModel
      • Array
      • TokenSuccessResponseDTO
      • NfeResponseDto
      • IsLocked
      • DocumentTotalResumeDTO
      • DocumentCteCityDTO
      • DocumentModel
      • ProcessRequestDTO
      • TokenErrorResponseDTO
      • NfeModelResponse
      • PublicCreateTokenDTO
      • AccountPayableTaxDataModel
      • DocumentCteProtocolDTO
      • GenericModel
      • ExportRequestFileModel
      • GenericHeaderModel
      • ChangeAuthPasswordDTO
      • NfseDocumentHeaderDto
      • GenericSuccessResponse
      • AccountPayable
      • DocumentCteQuantityInformationDTO
      • EntityRequestModel
      • Blob
      • RedefinePasswordDTO
      • NfseTax
      • BarcodeDetailDTO
      • DocumentCteCargoDetailsDTO
      • Object
      • ZipProcessorDTO
      • CreateMfaResponseDTO
      • ItemNfseDto
      • GetAllRequestItemSuccessResponse
      • BankAccountDTO
      • DocumentCteServiceComplementationDTO
      • PendingDto
      • ClientTreeOption
      • CreateMfaDTO
      • NfseDto
      • PixDetailDTO
      • EntityStatusModel
      • Additional
      • ActiveMfaDto
      • NfseResponseDto
      • TedDetailDTO
      • UpdateStatusDto
      • ExportFiltersModel
      • SendMfaVerificationDTO
      • NfseModelResponse
      • AbstractPaymentDetailDTO
      • EntityTimelineModel
      • CreateExportFiltersDTO
      • VerifyTokenResponseDTO
      • ConsumptionBillDocumentHeaderDto
      • TaxWithBarcodeDetailDTO
      • GetDataResponseDto
      • UpdateExportFiltersDTO
      • AddMfaTypeDTO
      • ItemGeneric
      • TableMetadata
      • DARFDetailDTO
      • PatchPriorityDto
      • SourceData
      • SetDefaultTypeDTO
      • ConsumptionBillDto
      • DARJDetailDTO
      • PendingResponseDto
      • QrCodeDTO
      • ConsumptionBillResponseDto
      • DPVATDetailDTO
      • IntegrationDTO
      • OidcInterceptorDTO
      • ConsumptionBillModelResponse
      • GAREDetailDTO
      • DocumentResponseDTO
      • String
      • HeaderResponse
      • UserIdDTO
      • CteCityDto
      • IPVADetailDTO
      • PaginatedDocumentsResponseDTO
      • MfaMyOptionsResponseDTO
      • CteTributesDto
      • LicensingDetailDTO
      • CreateTrustedDeviceDTO
      • CteShippingDto
      • SimpleDARFDetailDTO
      • AuthorizationGenerationDTO
      • CteCargoQuantityDetail
      • PayrollDetailDTO
      • ServerToServerTokenResponseDTO
      • CteCargoDetailsDto
      • InstallmentDTO
      • MfaDTO
      • CteTomadorDto
      • PaymentPurposeDTO
      • TenantResponseDTO
      • CteDocumentHeaderDto
      • AccountPayableTaxDataDTO
      • UserTenantResponseDTO
      • IdentificationModel
      • CteDto
      • AccountPayableDTO
      • OutputTenantDTO
      • ItemCategorizationModel
      • CteResponseDto
      • UserDetailDTO
      • CreateTokenResponseDTO
      • CteModelResponse
      • AccountPayableUpdateDTO
      • CreateTokenRequestDTO
      • AccountPayableUpdateStatusMetadataModel
      • ImpersonateUserDTO
      • AccountPayableUpdateStatusDTO
      • AccountPayableUpdateIsOpenDTO
      • MassUnlockDTO
      • CnaeCode
      • AccountPayableUpdateDefaultHolderBankDTO
      • LegalNature
      • AccountPayableReceiptDTO
      • SupplierData
      • AccountPayableRescheduleDTO
      • SupplierContent
      • RequestPaymentDTO
      • SupplierResponseDto
      • IntegrationEventMetadata
      • SupplierModelResponse
      • IntegrationEvent
      • IntegrationEventDTO
      • AccountPayableDeleteDTO
      • FileDto
      • AccountPayableEvent
      • DateModel
      • AttachsDto
      • Number
      • LegacyGetAttachsDto
      • GetDataDto
      • UniqueFiltersModel
      • PaginatedAccountPayable
      • SearchDTO
      • UpdateStatusResponseDto
      • ManifestationStatusModel
      • AccountPayableRedefineDetailDTO
      • ManifestationModel
      • AccountPayableRedefineMetadataDTO
      • AccountPayableUpdateIntegrationStatusDTO
      • AccountPayableAuthentication
      • AuthenticationDTO
      • AccountPayableExportDTO
      • PatchTranslatedDataDto
      • AccountPayableExportMetadata
      • AccountsPayableExportLog
      • AccountPayableExportUpdateDTO
      • ReprocessDto
      • Entity
    • DataDto
    • BaseResponse
    • AuditBigQueryRequest
    • AccountsPayableDto
    • DocumentType
    • CreateResponse
    • AuditBigQueryResponse
    • SyncRequest
    • BusinessPartner
    • Error
    • CreateResponseData
    • DeleteResponse
    • DataBaseDest
    • AuditBigQueryResponseData
    • SyncResponse
    • PurchaseItem
    • HTTPValidationError
    • DeleteResponseData
    • AuditStorageRequest
    • SyncResponseData
    • PaymentMethod
    • SignedUrlRequest
    • AuditStorageResponse
    • PurchaseOrderDto
    • Type
    • GetResponse
    • AuditStorageResponseData
    • Contact
    • UpdateStatusRequest
    • ProcessStatus
    • GetResponseData
    • Address
    • ValidationError
    • SignedUrlResponse
    • BankAccount
    • ListResponse
    • Branch
    • UpdateResponse
    • ListResponseData
    • AdditionalInfos
    • UpdateResponseData
    • PaginationData
    • DecryptFilesRequest
    • SupplierDto
    • DecryptFilesResponse
    • TaxDto
    • RequestItem
    • DecryptFilesResponseData
    • TaxCodeDto
    • DecryptedFileInfo
    • TaxCodeIrfDto
    • CostCenterDto
    • SignedUrlResponseData
    • PaymentConditionDto
    • ItemDto
    • Table
    • FinancialNatureDto
    • InvoiceItem
    • OutboundInvoiceDto
    • DeliveryAuthorizationItem
    • DeliveryAuthorizationDto
    • DeliveryDto
    • BlindReviewItem
    • LegacyDeliveryDTO
    • BlindReviewDto
    • EventHubDTO
    • GoodsThirdPartyDto
    • DeliverySuccessResponseDto
    • DeliveryBadRequestResponseDto
    • DeliveryUnauthorizedResponseDto
  1. Schemas

SupplierModelResponse

{
    "timestamp": 1717171717171,
    "message": "Request received successfully",
    "status": "success",
    "data": [
        {
            "type": "UPDATE",
            "header": {
                "id": "12345678-1234-1234-1234-123456789012",
                "master": "master123456789",
                "group": "GROUP001",
                "company": "company123456789",
                "establishment": "EST001"
            },
            "content": {
                "supplier": {
                    "id": "12345678-1234-1234-1234-123456789012",
                    "createdAt": "2024-01-15T10:30:00.000Z",
                    "updatedAt": "2024-01-15T10:35:00.000Z",
                    "deletedAt": null,
                    "name": "FORNECEDOR EXEMPLO LTDA",
                    "tradeName": "FORNECEDOR EXEMPLO",
                    "email": "contato@fornecedor.com",
                    "phone": "+5511999999999",
                    "master": "master123456789",
                    "masterName": "Master Name Example",
                    "country": "Brasil",
                    "adminEmail": "admin@fornecedor.com",
                    "city": "São Paulo",
                    "state": "SP",
                    "typeOf": "legal-person",
                    "document": "12345678000195",
                    "birthDate": "2010-01-01T00:00:00.000Z",
                    "status": "active",
                    "stateRegistration": "123456789",
                    "municipalRegistration": "987654321",
                    "taxRegime": "LUCRO_REAL",
                    "branchesCount": 3,
                    "isHeadquarter": true,
                    "erpCode": "SUP001",
                    "erpSystem": "DEFAULT",
                    "shareCapital": 100000,
                    "activityStartDate": "2010-01-01T00:00:00.000Z",
                    "cnaePrimaryCode": {
                        "code": "4711301",
                        "description": "Comércio varejista de mercadorias em geral"
                    },
                    "cnaeSecondaryCodes": [
                        {
                            "code": "4711302",
                            "description": "Comércio varejista de mercadorias em geral, com predominância de produtos alimentícios"
                        },
                        {
                            "code": "4711303",
                            "description": "Comércio varejista de mercadorias em geral, com predominância de produtos não alimentícios"
                        }
                    ],
                    "legalNature": {
                        "code": "2062",
                        "description": "Sociedade Empresária Limitada"
                    }
                },
                "contacts": [
                    {
                        "name": "João Silva",
                        "email": "joao@fornecedor.com",
                        "phone": "+5511987654321",
                        "position": "Gerente Comercial"
                    }
                ],
                "addresses": [
                    {
                        "street": "Rua das Flores",
                        "number": "123",
                        "zipCode": "01234567",
                        "city": "São Paulo",
                        "state": "SP",
                        "district": "Centro",
                        "complement": "Sala 101"
                    }
                ],
                "bankAccounts": [
                    {
                        "bank": "001",
                        "agency": "1234",
                        "account": "12345678",
                        "accountType": "CHECKING"
                    }
                ],
                "pixKeys": [
                    {
                        "key": "contato@fornecedor.com",
                        "type": "EMAIL"
                    }
                ]
            },
            "custom": {
                "customField1": "Custom Value 1",
                "customField2": "Custom Value 2"
            }
        }
    ]
}
Built with