POST Webhooks - EDD

Process for updating EDD date for ERP items.

Method: POST

Target URL: E.g. https://example.client.com/edd (Mandatory)

Required Fields

Request Body

{
  "destinationUrl": "https://example.com",
  "corporationId": 123456,
  "poReference": "5500000825",
  "items": [
    {
      "deliveryDate": "29.09.2024",
      "erpCode": "10"
    },
    {
      "deliveryDate": "29.09.2024",
      "erpCode": "20"
    }
  ]
}

Field Explanation

HTTP Status Codes

---

POST Webhooks - MMGOODS

Process for updating the delivery of ERP items.

Method: POST

Target URL: E.g. https://example.client.com/edd (Mandatory)

Minimum Recurrence: 5 minutes (Mandatory)

Required Fields

Request Body

{
  "destinationUrl": "https://example.com",
  "beginDate": "2024-08-16",
  "beginHour": "00:00:00",
  "endDate": "2024-08-17"
}

Result Body

[
  {
    "type": "item.delivery",
    "eventDate": "2024-01-19T20:24:01+03:00",
    "data": {
      "quantity": 1.000
    },
    "poId": "5000000906",
    "poItemId": "0001",
    "year": 2024,
    "documentErpId": "5500000291",
    "documentItemErpId": 10
  },
  {
    "type": "item.delivery",
    "eventDate": "2024-01-20T20:24:01+03:00",
    "data": {
      "quantity": 2.000
    },
    "poId": "5000000906",
    "poItemId": "0002",
    "year": 2024,
    "documentErpId": "5500000291",
    "documentItemErpId": 20
  }
]

Field Explanation

HTTP Status Codes

---

POST Webhooks - Invoice

Purpose: Process for updating and transmitting the details of a fiscal invoice (NF) for accurate recording and tax compliance.

• Invoice Data: Contains all the key information related to the fiscal invoice, including invoice number, series, issue date, and access key (if available).
• Tax Information: Includes detailed tax calculations and amounts, such as ICMS, PIS, COFINS, and other relevant taxes associated with the invoice.
• Goods and Service Details: Includes descriptions of the goods or services provided, quantities, unit prices, and total values.
• ERP Integration: Synchronizes invoice data with the company's ERP system, ensuring financial and inventory records are up to date.
• Regulatory Compliance: Ensures the fiscal invoice meets local tax and legal requirements, including tax codes, CFOP, and NCM for customs.

This webhook is used for:

• Invoice Transmission: Sending accurate and up-to-date invoice data to tax authorities or external systems.
• Tax and Financial Reporting: Ensuring correct tax reporting and compliance with fiscal regulations.
• ERP and Accounting Sync: Updating the ERP or accounting system with the latest invoice and tax information for accurate financial reporting.

Method: POST

Target URL: E.g. https://example.client.com/nota_fiscal (Mandatory)

Minimum Recurrence: 5 minutes (Mandatory)

Required Fields

Request Body

{
  "destinationUrl": "https://example.com",
  "beginDate": "2024-08-16",
  "beginHour": "00:00:00",
  "endDate": "2024-08-17"
}

Result Body

{
  "issuer": {
    "taxId": "12345678000199",
    "operationNature": "Venda de mercadoria",
    "companyName": "Empresa Emitente LTDA",
    "stateRegistration": "1234567890",
    "phone": "+55 11 98765-4321",
    "postalCode": "01001000",
    "address": "Rua das Flores",
    "addressNumber": "123",
    "district": "Centro",
    "city": "São Paulo",
    "state": "SP",
    "id": "ISS001"
  },
  "exporter": {
    "id": "EXP001",
    "taxId": "99887766000155",
    "companyName": "Exportadora Global SA",
    "state": "SP",
    "address": "Av. Paulista",
    "city": "São Paulo",
    "phone": "+55 11 2222-3333",
    "postalCode": "01311000",
    "addressNumber": "1500",
    "district": "Bela Vista",
    "corporationId": "CORP123",
    "stateRegistration": "5566778899"
  },
  "carrier": {
    "taxId": "44556677000188",
    "freightMode": "Rodoviário",
    "companyName": "Transportes Brasil LTDA",
    "anttCode": "ANTT12345",
    "vehiclePlate": "ABC1234",
    "vehicleState": "SP",
    "trailerPlate": "XYZ9876",
    "trailerState": "RJ",
    "stateRegistration": "8877665544",
    "address": "Rodovia BR-116",
    "city": "Guarulhos",
    "state": "SP",
    "volume": 10,
    "packageType": "Caixa",
    "brand": "MarcaTeste",
    "numbering": "12345",
    "grossWeight": 1500.50,
    "netWeight": 1200.30
  },
  "items": [
    {
      "cstIPI": "50",
      "cstPIS": "01",
      "cstCOFINS": "01",
      "cstICMS": "00",
      "fcpAmount": 15.55,
      "fcpRate": 2.0,
      "fcpBaseAmount": 777.50,
      "icmsOriginalAmount": 120.00,
      "icmsDeferredBaseAmount": 30.00,
      "icmsDeferredAmount": 6.00,
      "icmsDeferredRate": 20,
      "icmsReducedRate": 10,
      "sendStatisticalTaxFlag": true,
      "otherAdditionalExpensesAmount": 50.00,
      "afrmm": 22.50,
      "depositCode": "DP001",
      "id": 58306715,
      "materialCodeSap": "000000000010232022",
      "materialDescription": "EVRYSDI 0.75MG/1ML 80POSO BR",
      "goodsGroup": "62000",
      "codeCfop": "310101",
      "codeNcm": "30049069",
      "materialOrigin": "1",
      "materialUtilization": "0",
      "quantity": 522.0,
      "quantityMeasurementUnit": "EA",
      "netPrice": 19748.9,
      "netValue": 10308925.8,
      "codeSituationFiscalCofins": "73",
      "codeSituationFiscalPis": "73",
      "poNumber": "4500553011",
      "additionNumber": "001",
      "itemInAdditionNumber": "01",
      "diTagCodigoRelacaoCompradorVendedor": 1,
      "diTagFabricanteNome": "EXAMPLE MANUFACTURER LTD.",
      "baseValueIi": 10308925.8,
      "baseValueIpi": 11051168.45,
      "baseValuePis": 10308925.8,
      "baseValueCofins": 10308925.8,
      "baseValueIcms": 13523546.34,
      "baseValueIcmsSt": 0,
      "taxRateIi": 7.2,
      "taxRateIpi": 0,
      "taxRatePis": 2.76,
      "taxRateConfins": 13.03,
      "taxRateIcms": 18,
      "taxRateIcmsSt": 0,
      "taxValIi": 742242.65,
      "taxValIpi": 0,
      "taxValPis": 0,
      "taxValConfins": 0,
      "taxValIcms": 2434238.34,
      "taxValIcmsSt": 0,
      "otherExpenses": 38139.55,
      "positionErp": "10",
      "lots": null
    }
  ],
  "taxes": {
    "icmsBaseAmount": 1500.00,
    "icmsAmount": 180.00,
    "icmsStBaseAmount": 0,
    "icmsStAmount": 0,
    "importTaxAmount": 250.00,
    "pisAmount": 35.00,
    "productsTotalAmount": 5000.00,
    "freightTotalAmount": 300.00,
    "insuranceTotalAmount": 50.00,
    "afrmmTotalAmount": 40.00,
    "otherExpensesTotalAmount": 100.00,
    "ipiTotalAmount": 60.00,
    "cofinsTotalAmount": 161.00,
    "invoiceTotalAmount": 5700.00,
    "siscomexFeeAmount": 185.00,
    "fcpAmount": 20.50,
    "fcpTotalAmount": 25.00,
    "otherAdditionalExpensesTotalAmount": 90.00,
    "icmsBaseCalculo": 0,
    "icmsValor": 2434238.34,
    "icmsStBaseCalculo": 0,
    "icmsStValor": 0,
    "impValor": 742242.65,
    "pisValor": 0,
    "produtosValorTotal": 10308925.8,
    "freteValorTotal": 0,
    "seguroValorTotal": 0,
    "afrmmValorTotal": 0,
    "outrasDespesasValorTotal": 38139.55,
    "ipiValorTotal": 0,
    "cofinsValorTotal": 0,
    "nfValorTotal": 13523546.34,
    "taxaSiscomex": 154.23
  },
  "declarationType": "DI",
  "declarationNumber": "2024112233",
  "importDeclarationNumber": "51/2126868-6",
  "diIssueDate": "2024-10-01",
  "customsStorageName": "AEROPORTO INTERNACIONAL DO RIO DE JANEIRO/GALEãO",
  "customClearanceCodeDI": 7911101,
  "customClearanceDate": "2024-10-01",
  "ufDesemb": "RJ",
  "volume": {
    "quantity": 1,
    "type": "caixas",
    "brand": "",
    "number": "",
    "netWeight": 98.136,
    "grossWeight": 0
  },
  "invoiceData": {
    "number": "000024776",
    "series": "6",
    "chaveAcesso": null,
    "dataEmissao": null
  },
  "operation": {
    "typeNationalInvoice": "0002",
    "company": "2619",
    "localBusinessCompany": "0006",
    "codePartner": "0000120107",
    "incotermsOne": "CIP",
    "incotermsTwo": "AEROPORTO INTERNACIONAL GALEÃO",
    "importerCorporation": 365528,
    "mainCorporationId": 365527,
    "coverageExchangeCode": 1,
    "operationCodeTypeDI": "1"
  },
  "additionalData": "Número do embarque: 4500553011 Número da DI: 51/2126868-6 Data de registro da DI: 2024-10-01 ...",
  "useTransportedVolumeSpeciesListForNf": true,
  "lots": [
    {
      "id": 58306715,
      "erpCode": "10",
      "partNumber": "000000000010232022",
      "lotes": [
        {
          "id": "adbad2aa-787f-4631-9478-b1a01cf166ab",
          "loteName": "8910",
          "quantity": 12,
          "manufacturingDate": [2024, 10, 25],
          "expirationDate": [2024, 10, 25]
        }
      ]
    }
  ]
}

Field Explanation

HTTP Status Codes