Guides
System Status

Vendor archived & restored notification payloads

When you subscribe to the vendor.archived event, BILL sends a notification when a vendor is archived. When you subscribe to the vendor.restored event, BILL sends a notification when an archived vendor is restored.

Sample vendor.archived payload

In this sample unescaped JSON payload, the details of an archived vendor are available. The archived field is set as true.

{
    "metadata": {
        "eventId": "{event_id}",
        "subscriptionId": "{subscription_id}",
        "organizationId": "{organization_id}",
        "eventType": "vendor.created",
        "version": "1"
    },
    "vendor": {
        "id": "{vendor_id}",
        "name": "Happy Music Supplies",
        "archived": true,
        "email": "[email protected]",
        "phone": "9876543210",
        "networkStatus": "NOT_CONNECTED",
        "accountNumber": 987000654,
        "address": {
            "line1": "123 Main St",
            "line2": "Suite 200",
            "city": "San Jose",
            "stateOrProvince": "CA",
            "zipOrPostalCode": "95002",
            "country": "US"
        },
        "paymentInformation": {
            "payeeName": "Happy Music Supplies",
            "email": "[email protected]",
            "payByType": "ACH",
            "virtualCard": {
                "status": "UNENROLLED"
            }
        },
        "additionalInfo": {
            "taxId": "9998887777",
            "taxIdType": "SSN",
            "track1099": true,
            "leadTimeInDays": 10,
            "combinePayments": true,
            "companyName": "Happy Music Supplies"
        },
        "recurringPayments": false,
        "billCurrency": "USD",
        "balance": {
            "amount": 0.00
        },
        "autoPay": {
            "enabled": false
        },
        "createdTime": "2025-12-15T22:53:15.127+00:00",
        "updatedTime": "2025-12-25T22:53:15.127+00:00" 
    }
}

Sample vendor.restored payload

In this sample unescaped JSON payload, the details of a restored vendor are available. The archived field is set as false.

{
    "metadata": {
        "eventId": "{event_id}",
        "subscriptionId": "{subscription_id}",
        "organizationId": "{organization_id}",
        "eventType": "vendor.created",
        "version": "1"
    },
    "vendor": {
        "id": "{vendor_id}",
        "name": "Happy Music Supplies",
        "archived": false,
        "email": "[email protected]",
        "phone": "9876543210",
        "networkStatus": "NOT_CONNECTED",
        "accountNumber": 987000654,
        "address": {
            "line1": "123 Main St",
            "line2": "Suite 200",
            "city": "San Jose",
            "stateOrProvince": "CA",
            "zipOrPostalCode": "95002",
            "country": "US"
        },
        "paymentInformation": {
            "payeeName": "Happy Music Supplies",
            "email": "[email protected]",
            "payByType": "ACH",
            "virtualCard": {
                "status": "UNENROLLED"
            }
        },
        "additionalInfo": {
            "taxId": "9998887777",
            "taxIdType": "SSN",
            "track1099": true,
            "leadTimeInDays": 10,
            "combinePayments": true,
            "companyName": "Happy Music Supplies"
        },
        "recurringPayments": false,
        "billCurrency": "USD",
        "balance": {
            "amount": 0.00
        },
        "autoPay": {
            "enabled": false
        },
        "createdTime": "2025-12-15T22:53:15.127+00:00",
        "updatedTime": "2025-12-26T22:53:15.127+00:00" 
    }
}

Updated 7 days ago