Invoice Status Draft

An invoice's status was changed to draft

Payload

The payload of this webhook request is an object.
eventTypestringRequired
invoiceobjectRequired
userobjectOptional
User who initiated the change.

Response

200
any
Return a 200 status to indicate that the data was received successfully.
Payload
1{
2  "eventType": "invoice.status.draft",
3  "invoice": {
4    "id": "inv_26e7b5d3-a739-4b23-9ad9-6aaa085f47a9",
5    "status": "DRAFT",
6    "paymentDestinationConfirmed": true,
7    "hasDocuments": true,
8    "hasSourceEmail": true,
9    "approvers": [],
10    "approvalPolicy": [],
11    "metadata": {},
12    "createdAt": "2021-01-01T00:00:00Z",
13    "updatedAt": "2021-01-01T00:00:00Z",
14    "payerId": "ent_8545a84e-a45f-41bf-bdf1-33b42a55812c",
15    "payer": {
16      "acceptedTos": true,
17      "accountType": "business",
18      "createdAt": "2024-01-01T00:00:00Z",
19      "email": "customer@acme.com",
20      "id": "ent_8545a84e-a45f-41bf-bdf1-33b42a55812c",
21      "isCustomer": true,
22      "isNetworkPayee": false,
23      "isNetworkPayor": false,
24      "isPayee": false,
25      "isPayor": true,
26      "name": "Acme Inc.",
27      "profile": {
28        "business": {
29          "legalBusinessName": "Acme Inc.",
30          "taxIDProvided": true,
31          "email": "customer@acme.com",
32          "businessType": "llc",
33          "phone": {
34            "countryCode": "1",
35            "number": "4155551234"
36          },
37          "address": {
38            "addressLine1": "123 Main St",
39            "city": "San Francisco",
40            "stateOrProvince": "CA",
41            "postalCode": "94105",
42            "addressLine2": "Unit 1",
43            "country": "US"
44          },
45          "ownersProvided": true
46        }
47      },
48      "status": "verified",
49      "updatedAt": "2024-01-02T00:00:00Z",
50      "accounts": [
51        {
52          "accountId": "85866843",
53          "postalCode": "94105",
54          "nameOnAccount": "John Doe"
55        }
56      ],
57      "counterpartyType": [
58        "ENTITY"
59      ],
60      "foreignId": "MY-DB-ID-12345",
61      "paymentMethods": [
62        {
63          "type": "bankAccount",
64          "accountName": "My Checking Account",
65          "accountNumber": "99988767623",
66          "accountType": "CHECKING",
67          "bankName": "Chase",
68          "createdAt": "2021-01-01T00:00:00Z",
69          "frozen": false,
70          "id": "pm_4794d597-70dc-4fec-b6ec-c5988e759769",
71          "isDefaultDestination": true,
72          "isDefaultSource": true,
73          "metadata": {},
74          "routingNumber": "12345678",
75          "status": "VERIFIED",
76          "supportedCurrencies": [
77            "USD"
78          ],
79          "updatedAt": "2021-01-01T00:00:00Z"
80        }
81      ]
82    }
83  },
84  "user": {
85    "id": "user_ec3aafc8-ea86-408a-a6c1-545497badbbb",
86    "roles": [
87      "admin",
88      "approver"
89    ],
90    "createdAt": "2024-01-01T00:00:00Z",
91    "updatedAt": "2024-01-01T00:00:00Z",
92    "foreignId": "MY-DB-ID-12345",
93    "email": "john.doe@acme.com",
94    "name": "John Doe"
95  }
96}
Built with