Integração com ERP

Conheça abaixo as notificações enviadas pela Blue Fleet para integração com ERPs

Estas notificações possuem um controle específico por transação, e podem ser monitoradas e controladas pelo sistema. É esperado um retorno 200 OK para cada transação, e no caso de erro, uma pendência é criada no seção de integração com ERP para que o problema seja analisado e a transação possa ser recolocada na fila de notificação.

Faturas e notas de débito

Esta requisição é disparada após a geração de uma fatura ou nota de débito no Blue Fleet. POST /debt-note Exemplo: https://www.seusite.com.br/webhooks/debt-note

{
  "DebtNoteId": 0,
  "Customer": {
    "CustomerId": 0,
    "CompanyName": "",
    "TradingName": "",
    "CustomerTypeId": 0,
    "CustomerTypeName": "",
    "RegisteredNumber": "",
    "NationalId": "",
    "PhoneNumber": "",
    "Email": ""
  },
  "DocumentNumber": "",
  "CreatedAt": "0001-01-01T00:00:00",
  "CreatedBy": {
    "UserId": 0,
    "Name": ""
  },
  "Discounts": 0.0,
  "TotalValue": 0.0,
  "Comments": "",
  "DebtNoteTypeId": 0,
  "DebtNoteTypeName": "",
  "PaymentDetails": "",
  "DueDate": "0001-01-01T00:00:00",
  "DebtNoteStatusId": 0,
  "DebtNoteStatusName": "",
  "IssuanceDate": "0001-01-01T00:00:00",
  "SuppressDueDate": "0001-01-01T00:00:00",
  "CanceledAt": "0001-01-01T00:00:00",
  "CanceledBy": {
    "UserId": 0,
    "Name": ""
  },
  "AccrualDate": "0001-01-01T00:00:00",
  "BuyerId": 0,
  "FleetManagerBranch": {
    "FleetManagerBranchId": 0,
    "DisplayName": "",
    "RegisteredNumber": ""
  },
  "BillingTypeId": 0,
  "BillingTypeName": "",
  "BankDetails": {
    "BankAccountId": 0,
    "BankId": 0,
    "BankCode": "",
    "BankName": "",
    "AgencyNumber": "",
    "AccountNumber": "",
    "OpeningDate": "0001-01-01T00:00:00",
    "OpeningBalance": 0,
    "BankAccountTypeId": 0,
    "BankAccountExternalId": ""
  },
  "Contract": {
    "ContractId": 0,
    "DocumentNumber": "",
    "ContractNumber": "",
    "DocumentCustomNumber": ""
  },
  "ContractItem": {
    "ContractItemId": 0,
    "DocumentNumber": ""
  },
  "DebtNoteItems": [
    {
      "DebtNoteItemId": 0,
      "Description": "",
      "Quantity": 0,
      "UnitValue": 0.0,
      "TotalValue": 0.0,
      "Order": 0
    }
  ],
  "FinancialEntries": [
    {
      "FinancialEntryId": 0,
      "ExpectedDate": "0001-01-01T00:00:00",
      "ExpectedValue": 0.0
    }
  ],
  "FinancialEntryPaymentTypesFinancialEntryPaymentTypeId": 0,
  "FinancialEntryPaymentTypesName": "",
  "FinancialEntryPaymentTypeExternalId": 0,
  "FinancialEntryPaymentConditionsFinancialEntryPaymentConditionId": 0,
  "FinancialEntryPaymentConditionsName": "",
  "FinancialEntryPaymentConditionExternalId": ""
}

Lançamentos financeiros

Esta requisição é disparada após a criação de lançamento no contas a pagar ou contas a receber no Blue Fleet. POST /financial-entry Exemplo: https://www.seusite.com.br/webhooks/financial-entry

{
  "FinancialEntryId": 0,
  "FinancialEntryTypeId": 0,
  "FinancialEntryTypeName": "",
  "FinancialRecurrenceFrequencyTypeId": 0,
  "FinancialRecurrenceFrequencyTypeName": "",
  "FinancialEntryStatusId": 0,
  "FinancialEntryStatusName": "",
  "BankAccount": {
    "BankAccountId": 0,
    "Name": "",
    "BankCode": "",
    "BankName": "",
    "AgencyNumber": "",
    "AccountNumber": "",
    "ExternalId": ""
  },
  "CostCenter": {
    "CostCenterId": 0,
    "FullDescription": ""
  },
  "FinancialEntity": {
    "FinancialEntityId": 0,
    "Name": "",
    "DocumentNumber": "",
    "FinancialEntityTypeId": 0,
    "FinancialEntityTypeName": "",
    "FinancialEntityClassId": 0,
    "FinancialEntityClassName": "",
    "PhoneNumber": "",
    "Email": ""
  },
  "CurrentInstallment": 0,
  "TotalInstallments": 0,
  "CreatedBy": {
    "UserId": 0,
    "Name": ""
  },
  "CreatedAt": "0001-01-01T00:00:00",
  "ExpectedValue": 0.0,
  "ExpectedDate": "0001-01-01T00:00:00",
  "ExpirationDate": "0001-01-01T00:00:00",
  "Description": "",
  "Comments": "",
  "Performed": false,
  "PerformedBy": {
    "UserId": 0,
    "Name": ""
  },
  "PerformedAt": "0001-01-01T00:00:00",
  "PerformedValue": 0.0,
  "Reconciled": false,
  "ReconciledBy": {
    "UserId": 0,
    "Name": ""
  },
  "ReconciledAt": "0001-01-01T00:00:00",
  "Confirmed": false,
  "PerformedDate": "0001-01-01T00:00:00",
  "ConfirmedAt": "0001-01-01T00:00:00",
  "ConfirmedBy": {
    "UserId": 0,
    "Name": ""
  },
  "FinancialRecurrenceTypeId": 0,
  "FinancialRecurrenceTypeName": "",
  "ReferenceDate": "0001-01-01T00:00:00",
  "PaymentType": {
    "FinancialEntryPaymentTypeId": 0,
    "Name": ""
  },
  "IsDeleted": false,
  "DeletedBy": {
    "UserId": 0,
    "Name": ""
  },
  "PurchaseOrderId": 0,
  "FinancialInvoiceId": 0,
  "AccrualDate": "0001-01-01T00:00:00",
  "Taxes": 0.0,
  "Discounts": 0.0,
  "Interest": 0.0,
  "Fine": 0.0,
  "ExpectedGrossValue": 0.0,
  "IsTransfer": false,
  "DocumentNumber": "",
  "FinancialEntryNumber": ""
}

Notas fiscais

Esta requisição é disparada após o cadastro de uma nota fiscal no Blue Fleet. POST /financial-invoice Exemplo: https://www.seusite.com.br/webhooks/financial-invoice

{
  "FinancialInvoiceId": 0,
  "InvoiceNumber": "",
  "InvoiceSeries": "",
  "TotalValue": 0.0,
  "FinancialEntity": {
    "FinancialEntityId": 0,
    "Name": "",
    "DocumentNumber": "",
    "FinancialEntityTypeId": 0,
    "FinancialEntityTypeName": "",
    "FinancialEntityClassId": 0,
    "FinancialEntityClassName": "",
    "PhoneNumber": "",
    "Email": ""
  },
  "IrrfValue": 0.0,
  "IssValue": 0.0,
  "InssValue": 0.0,
  "PisValue": 0.0,
  "CofinsValue": 0.0,
  "CsllValue": 0.0,
  "CreatedAt": "0001-01-01T00:00:00",
  "CreatedBy": {
    "UserId": 0,
    "Name": ""
  },
  "FinancialInvoiceStatusId": 0,
  "FinancialInvoiceStatusName": "",
  "IssuedAt": "0001-01-01T00:00:00",
  "Comments": "",
  "IpiValue": 0.0,
  "IcmsValue": 0.0,
  "InputtedAt": "0001-01-01T00:00:00",
  "FinancialInvoiceTypeId": 0,
  "FinancialInvoiceTypeName": "",
  "CanceledAt": "0001-01-01T00:00:00",
  "CanceledBy": {
    "UserId": 0,
    "Name": ""
  },
  "FleetManagerBranch": {
    "FleetManagerBranchId": 0,
    "DisplayName": "",
    "RegisteredNumber": ""
  },
  "Description": "",
  "Discount": 0.0,
  "Chassis": "",
  "AccessCode": "",
  "FinancialInvoiceDocumentTypeId": 0,
  "FinancialInvoiceDocumentTypeName": "",
  "IsTicketLog": false,
  "FinancialEntries": [
    {
      "FinancialEntryId": 0,
      "FinancialEntryTypeId": 0,
      "FinancialEntryTypeName": "",
      "FinancialEntryStatusId": 0,
      "FinancialEntryStatusName": "",
      "BankAccount": {
        "BankAccountId": 0,
        "Name": "",
        "BankCode": "",
        "BankName": "",
        "AgencyNumber": "",
        "AccountNumber": "",
        "ExternalId": ""
      },
      "FinancialEntity": {
        "FinancialEntityId": 0,
        "Name": "",
        "DocumentNumber": "",
        "FinancialEntityTypeId": 0,
        "FinancialEntityTypeName": "",
        "FinancialEntityClassId": 0,
        "FinancialEntityClassName": "",
        "PhoneNumber": "",
        "Email": ""
      },
      "CurrentInstallment": 0,
      "TotalInstallments": 0,
      "ExpectedValue": 0.0,
      "ExpectedDate": "0001-01-01T00:00:00",
      "ExpirationDate": "0001-01-01T00:00:00",
      "Description": "",
      "Comments": "",
      "Performed": false,
      "PerformedAt": "0001-01-01T00:00:00",
      "PerformedDate": "0001-01-01T00:00:00",
      "PerformedValue": 0.0,
      "Reconciled": false,
      "ReconciledAt": "0001-01-01T00:00:00",
      "Confirmed": false,
      "ConfirmedAt": "0001-01-01T00:00:00",
      "ReferenceDate": "0001-01-01T00:00:00",
      "PaymentType": {
        "FinancialEntryPaymentTypeId": 0,
        "Name": ""
      },
      "AccrualDate": "0001-01-01T00:00:00",
      "Taxes": 0.0,
      "Discounts": 0.0,
      "Interest": 0.0,
      "Fine": 0.0,
      "ExpectedGrossValue": 0.0,
      "FinancialEntryNumber": 0
    }
  ],
  "FinancialEntriesInvoiceContractItems": [
    {
      "RequestNumber": "",
      "OrderNumber": "",
      "ContractItemRequestOrderId": 0,
      "ContractItemRequestOrderItemId": 0,
      "Description": "",
      "Total": 0.0,
      "ContractItemRequestOrderItemPartTypeName": "",
      "ContractItemRequestOrderItemClassName": "",
      "ExpenseGroupName": "",
      "ContractItemId": 0,
      "ContractItemRequestId": 0,
      "Refundable": 0.0,
      "Discount": 0.0
    }
  ],
  "Files": [
    {
      "Url": "",
      "FileTypeName": "",
      "FileName": ""
    }
  ],
  "ProviderAddress": {
    "Address": "",
    "Address2": "",
    "AddressNumber": "",
    "County": "",
    "City": "",
    "State": "",
    "Country": "",
    "PostalCode": ""
  }
}

Last updated