Escrituração da Duplicata

Documentar o webhook que comunica o retorno de uma escrituração, podendo ser o retorno de sucesso ou falha.

Sua API deve respeitar o princípio de idempotência, pois em casos raros o webhook poderá ser entregue mais de uma vez.

Exemplo de payload

{
    "_links": {
        "booking-invoices": {
            "href": "https://{url do ambiente}/v1/companies/12292693000112/booking-invoices",
            "type": "GET"
        }
    },
    "sellerGovernmentId": "12292693000112",
    "bookedInvoices": [
        {
            "id": "6ac5c532-6d59-49a9-bdaf-f79a6e160a11",
            "externalId": "EXT-0002",
            "paymentDate": 1785553200000,
            "paymentValue": 1000,
            "invoiceNumber": "INV-0002",
            "installment": "1",
            "assetType": "NOTA_SERVICO",
            "invoiceValue": 1000,
            "sponsorGovernmentId": "06188451000180",
            "tradeRepositoryId": "JR-123456"
        }
    ],
    "refusedInvoices": [
        {
            "id": "6ac5c532-6d59-49a9-bdaf-f79a6e160a11",
            "externalId": "EXT-0001",
            "paymentDate": 1785553200000,
            "paymentValue": 1000,
            "invoiceNumber": "INV-0001",
            "installment": "1",
            "assetType": "NOTA_SERVICO",
            "invoiceValue": 1000,
            "sponsorGovernmentId": "06188451000180",
            "detail": "Campo Numero do documento invalido."
        }
    ]
}

Did this page help you?