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

DocumentResponseDTO

{
    "file": {
        "internalId": "string",
        "origin": "string",
        "name": "string",
        "displayName": "string",
        "step": "string",
        "stepOrder": 0,
        "message": "string",
        "uploadDate": "2019-08-24T14:15:22.123Z",
        "processStatus": "string",
        "visible": true,
        "duplicated": true,
        "deletedDocument": true,
        "isConsolidated": true,
        "finalized": true,
        "dueDate": "2019-08-24T14:15:22.123Z"
    },
    "fileErp": {
        "fiscalIntegrationMessage": "string",
        "fiscalIntegrationValue": "string",
        "accountingIntegrationMessage": "string",
        "accountingIntegrationValue": "string"
    },
    "documentType": "NFSe",
    "accessKey": "string",
    "number": "string",
    "series": "string",
    "issueDate": "2019-08-24T14:15:22.123Z",
    "cancelled": true,
    "value": 0,
    "liquidValue": 0,
    "dueDate": "2019-08-24T14:15:22.123Z",
    "provider": {
        "nationalRegister": "string",
        "name": "string",
        "tradeName": "string",
        "legallyActive": true,
        "optantSimples": true,
        "optantMei": true,
        "address": {
            "city": "string",
            "cityUniqueCode": "string",
            "state": "string",
            "district": "string",
            "street": "string",
            "number": "string",
            "complement": "string",
            "zipCode": "string",
            "country": "string"
        }
    },
    "beneficiary": {
        "nationalRegister": "string",
        "name": "string",
        "tradeName": "string",
        "legallyActive": true,
        "optantSimples": true,
        "optantMei": true,
        "address": {
            "city": "string",
            "cityUniqueCode": "string",
            "state": "string",
            "district": "string",
            "street": "string",
            "number": "string",
            "complement": "string",
            "zipCode": "string",
            "country": "string"
        }
    },
    "authorizationCode": "string",
    "purchaseOrder": [
        "string"
    ],
    "service": {
        "sameAddress": true,
        "description": "string",
        "discrimination": "string",
        "code": "string",
        "serviceMadeCity": "string"
    },
    "serviceSheet": [
        "string"
    ],
    "claimant": "string",
    "transferValue": 0,
    "paymentProviderStatus": "string",
    "cpom": {
        "description": "string",
        "aliquot": 0
    },
    "tributes": {},
    "decrementValue": 0,
    "incrementValue": 0,
    "fineValue": 0,
    "keyAccessDigit": "string",
    "issueType": 0,
    "invoiceModel": "string",
    "transport": {
        "modality": 0,
        "carrierName": "string"
    },
    "finalCostumer": true,
    "kindOperationDescription": "string",
    "additionalInformation": "string",
    "complementDescription": "string",
    "payment": {
        "form": "string",
        "method": "string"
    },
    "totalResume": {
        "pisValue": 0,
        "cofinsValue": 0,
        "icmsStValue": 0,
        "icmsValue": 0,
        "insuranceValue": 0,
        "ipiValue": 0,
        "tributesTotalValue": 0,
        "discountValue": 0,
        "totalValue": 0,
        "transportValue": 0,
        "icmsValueDisregarded": 0,
        "icmsCalculationBasis": 0
    },
    "shipping": {
        "nationalRegister": "string",
        "name": "string",
        "tradeName": "string",
        "legallyActive": true,
        "optantSimples": true,
        "optantMei": true,
        "address": {
            "city": "string",
            "cityUniqueCode": "string",
            "state": "string",
            "district": "string",
            "street": "string",
            "number": "string",
            "complement": "string",
            "zipCode": "string",
            "country": "string"
        }
    },
    "additionalBeneficiary": {
        "nationalRegister": "string",
        "name": "string",
        "tradeName": "string",
        "legallyActive": true,
        "optantSimples": true,
        "optantMei": true,
        "address": {
            "city": "string",
            "cityUniqueCode": "string",
            "state": "string",
            "district": "string",
            "street": "string",
            "number": "string",
            "complement": "string",
            "zipCode": "string",
            "country": "string"
        }
    },
    "receiver": {
        "nationalRegister": "string",
        "name": "string",
        "tradeName": "string",
        "legallyActive": true,
        "optantSimples": true,
        "optantMei": true,
        "address": {
            "city": "string",
            "cityUniqueCode": "string",
            "state": "string",
            "district": "string",
            "street": "string",
            "number": "string",
            "complement": "string",
            "zipCode": "string",
            "country": "string"
        }
    },
    "dispatcher": {
        "nationalRegister": "string",
        "name": "string",
        "tradeName": "string",
        "legallyActive": true,
        "optantSimples": true,
        "optantMei": true,
        "address": {
            "city": "string",
            "cityUniqueCode": "string",
            "state": "string",
            "district": "string",
            "street": "string",
            "number": "string",
            "complement": "string",
            "zipCode": "string",
            "country": "string"
        }
    },
    "cityFinish": {
        "name": "string",
        "cityUniqueCode": "string",
        "state": "string"
    },
    "cityShipping": {
        "name": "string",
        "cityUniqueCode": "string",
        "state": "string"
    },
    "cityStart": {
        "name": "string",
        "cityUniqueCode": "string",
        "state": "string"
    },
    "accessKeyNfe": [
        "string"
    ],
    "documentProtocol": {
        "protocol": "string",
        "status": "string",
        "receiptDate": "2019-08-24T14:15:22.123Z",
        "digestValue": "string",
        "documentNumber": "string",
        "version": "string",
        "receiptAppVersion": "string",
        "responseStatusCode": "string"
    },
    "cargoDetails": {
        "cargoValue": 0,
        "predominantProduct": "string",
        "quantityInformation": [
            {
                "measureType": "string",
                "quantity": 0,
                "unitCode": 0
            }
        ],
        "otherCharacteristics": "string"
    },
    "cfop": "string",
    "operationNature": "string",
    "transportMode": 0,
    "serviceType": 0,
    "serviceComplementation": [
        {
            "name": "string",
            "value": 0
        }
    ],
    "receivableValue": 0,
    "rntrc": 0,
    "model": "string",
    "contractNumbers": [
        "string"
    ],
    "exitDate": "2019-08-24T14:15:22.123Z",
    "takerType": 0,
    "takerStateRegistrationIndicator": 0
}
Built with