Create an employee
Archive a vendor
archived
field is set as true
. you can restore an archived vendor with post /v3/vendors/\{vendorid\}/restore
. there is no change when you archive an archived vendor.Api login as user
Check app health
Create an accounting class
Archive a user
archived
field is set as true
.” you can restore an archived user with post /v3/users/\{userid\}/restore
. there is no change when you archive an archived user.Archive an item
archived
field is set as true
.Create a chart of accounts
Create a bulk payment
Create a customer
Delete a budget
Create custom field values
Create an image upload url for a reimbursement
Create a user
administrator
user role in the bill organization to perform this operation. see organizations and users in the guides section for more information, sample requests, and responses.Delete a card
Create a reimbursement
Delete a custom field
Delete custom field values
Delete a member from a budget
Delete customer connection
Delete a vendor bank account
delete /v3/vendors/\{vendorid\}/bank-account
), and then create a new vendor bank account (with post /v3/vendors/\{vendorid\}/bank-account
) with the updated information.Delete a reimbursement
Create a recurring bill
Delete vendor connection
Delete a user
Get a single member for a budget
Get accounting class details
Get api session details
Get attachment details
downloadlink
in a get request to download the attachment. curl '{downloadlink}&sessionid={session id}' --output {attachment name}
Generate mfa challenge
Get audit trail details for a vendor
Create a vendor
Accept network invitation
Get bank account details
Api partner login
Get chart of accounts details
Get card funding purpose
post /v3/payments
or post /v3/payments/bulk
) with a card account
funding account type
, bill requires a vendor industry value for compliance. when bill cannot identify the vendor industry, the cardfundingpurpose
field must be set in your payment request. use this endpoint to get the list of card funding purpose values you can set. if you get an empty 200 response, bill has information about the vendor industry and setting the cardfundingpurpose
field is not required in your payment request.Api logout
sessionid
expires and your api session is terminated. you will be required to sign in again with /v3/login
before you can make another api call.Add phone for mfa setup
Get check image data
downloadlink
in a get request to download the front and back images of the check. curl '{downloadlink}&sessionid={session id}' --output {check name}
Get card account details
Add phone for risk verification
get /v3/risk-verifications/phone
. after you add a phone number with this endpoint, you can initiate risk verification for the organization with post /v3/risk-verifications
.Get card details
Get customer invitation status
post /v3/network/invitation/customer/\{customerid\}
. when the customer accepts the invitation, your organization is connected with the customer. note: if the invited customer does not respond to an invitation for 60 days, the invitation expires. see bill network in the guides section for more information, sample requests, and responses.Get customer details
Get bill details
Api login
sessionid
is available. use the sessionid
in all subsequent api calls to confirm that you are in a signed-in session. to create an mfa-trusted api session, set remembermeid
and device
in addition to the required fields. see mfa setup for information about the bill mfa process. you can sign out with post /v3/logout
. if your api session is inactive for 35 minutes, the session expires and you are automatically signed out. see api partner login for information about the additional permissions you get with the api partner login. note: this section is about authentication for working with the bill v3 api. see authentication with spend & expense api token for information about authentication for the spend & expense api endpoints.Create a vendor bank account
delete /v3/vendors/\{vendorid\}/bank-account
), and then create a new vendor bank account (with post /v3/vendors/\{vendorid\}/bank-account
) with the updated information. note: when you add vendor bank account information, bill requires 2 business days to complete a one-time verification of the bank account. payments sent to the vendor are processed after the one-time verification is complete. see get list of vendor payment options to get details about vendor payment options and payment process dates.Get custom field details
Get department details
Get budget details
Get employee details
Create a vendor card
Get document upload status
in progress
), bill generates an uploadid
for the document. the value begins with 0du
. * when the document upload is complete (uploaded
), bill generates a documentid
for the document. the value begins with 00h
.Archive a customer
archived
field is set as true
. you can restore an archived customer with post /v3/customers/\{customerid\}/restore
. there is no change when you archive an archived customer.Get custom field value
Get document details
downloadlink
in a get request to download the document. curl '{downloadlink}&sessionid={session id}' --output {document name}
Approve or deny a reimbursement
Archive a bank account user
archived
field is set as true
and the bank account user verificationstatus
is set as unverified
.Archive an accounting class
archived
field is set as true
.Archive a department
archived
field is set as true
.Create an item
Create custom field
Archive a bank account
archived
field is set as true
. archiving a bank account at bill has a set of requirements. * bank account status: the bank account status
must be set as verified
. you can verify the bank account with post /v3/funding-accounts/banks/\{bankaccountid\}/verify
. * bank account user status: the bank account user verificationstatus
must be set as verified
. to begin the verification process, nominate a bank account user with post /v3/funding-accounts/banks/users
.Archive multiple departments
archived
field is set as true
.Archive multiple employees
archived
field for each object is set as true
.Archive a bill
archived
field is set as true
. you can restore an archived bill with post /v3/bills/\{billid\}/restore
. there is no change when you archive an archived bill.Archive a job
archived
field is set as true
.Create a bank account
administrator
user role in the bill organization to perform this operation. bill sends an email notification for informing you about changes to your funding accounts. note: when you create a bank account, bill sends a test ach payment to the bank account to confirm whether the account details are accurate. in the response, three fields are set to their default values. * the bank account status
is set as pending
. you can verify the bank account with post /v3/funding-accounts/banks/\{bankaccountid\}/verify
. * the payables
and receivables
values are set as false
. to update these values, update the bank account with patch /v3/funding-accounts/banks/\{bankaccountid\}
. see bank account setup (v3 api) in the guides section for more information, sample requests, and responses.Archive a recurring bill
archived
field is set as true
. you can restore an archived recurring bill with post /v3/recurringbills/\{recurringbillid\}/restore
. there is no change when you archive an archived recurring bill. when a recurring bill is modified, all future bills are automatically changed.Create a department
Create a job
Archive a location
archived
field is set as true
.Create an invoice
Create a location
Create a bill
Archive mutliple chart of accounts
archived
field for each object is set as true
.Archive an invoice
archived
field is set as true
. you can restore an archived invoice with post /v3/invoices/\{invoiceid\}/restore
. there is no change when you archive an archived invoice.Archive an employee
archived
field is set as true
.Archive multiple locations
archived
field for each object is set as true
.Archive multiple jobs
archived
field for each object is set as true
.Create an organization
sessionid
header value generated with api partner login * an appkey
header value see organizations for bill partners in the guides section for more information, sample requests, and responses.Archive a chart of accounts
archived
field is set as true
.Archive multiple items
archived
field for each object is set as true
.Create a budget
Cancel a payment
post /v3/payments/\{paymentid\}/cancel
based on a set of conditions. see <a href=“https://help.bill.com/hc/en-us/articles/115005898063”>payment cancelation and void cut-off timing</a> in the bill help center to learn about the bill cancel payment process and timing. if the conditions are not met, you cannot cancel the payment. at that point, you can attempt to void the payment with post /v3/payments/\{paymentid\}/void
.Create a payment
Archive multiple accounting classes
archived
field for each object is set as true
.Get current user details
Get funding account permissions
Get list of bank account users
verificationstatus
is set as nominated
, user verification must be completed before the user can pay with the specified bank account. by default, you get 20 results on one page of results. set max
in your request to get up to 100 results on one page.Get list of vendor payment options
Get invoice details
Get item details
Get location details
Get transaction custom field details
Get list of organization industries
industry
field for an organization. use this information to set the industry
field in your post /v3/partner/organizations
or patch /v3/organizations/\{organizationid\}
request.Get risk verification details
Get list of employees
max
in your request to get up to 100 results on one page. see search operations with lists in the guides section for filtering, sorting, and pagination examples.Get list of organizations
max
in your request to get up to 100 results on one page. see search operations with lists in the guides section for filtering, sorting, and pagination examples. this operation requires partner-level permissions. * a sessionid
header value generated with api partner login * an appkey
header valueGet international payments configuration
paymentpurpose
and regulatoryfields
information is retrieved for the vendor. note: if you are adding paymentpurpose
and regulatoryfields
information after creating an international vendor, use get /v3/vendors/\{vendorid\}/configuration
to get the required configuration for your created vendor. see creating an international vendor for more information on how to set paymentpurpose
and regulatoryfields
.Get list of bills
max
in your request to get up to 100 results on one page. see search operations with lists in the guides section for filtering, sorting, and pagination examples.Get list of documents
downloadlink
in a get request to download the document. curl '{downloadlink}&sessionid={session id}' --output {document name}
Get list of vendor attachments
downloadlink
in a get request to download the attachment. curl '{downloadlink}&sessionid={session id}' --output {attachment name}
Get job details
Get vendor details
Get vendor invitation status
post /v3/network/invitation/vendor/\{vendorid\}
. when the vendor accepts the invitation, your organization is connected with the vendor. note: if the invited vendor does not respond to an invitation for 60 days, the invitation expires. see bill network in the guides section for more information, sample requests, and responses.Get list of recurring bills
max
in your request to get up to 100 results on one page. see search operations with lists in the guides section for filtering, sorting, and pagination examples.Get list of payments
max
in your request to get up to 100 results on one page. see search operations with lists in the guides section for filtering, sorting, and pagination examples.Initiate risk verification for an organization
administrator
user role in the bill organization to perform this operation. note: you must add a phone number for the signed-in user (with post /v3/risk-verifications/phone
) before you can initiate risk verification. bill partners must add a phone number for a created user with post /v3/partner/risk-verifications/\{userid\}/phone
. as a bill partner, when you create an organization and then create a user for that organization, it is important that you initiate risk verification with post /v3/risk-verifications
. bill performs a kyc/kyb (know you customer/know your business) check based on the provided organization information. bill sends an email notification for risk verficiation. when the check is complete, bill approves the organization for bill ap and ar operations.Get transaction custom field value details
Get list of invoices
max
in your request to get up to 100 results on one page. see search operations with lists in the guides section for filtering, sorting, and pagination examples.Get organization details
administrator
user role in the bill organization to perform this operation. see organizations and users in the guides section for more information, sample requests, and responses.Invite a customer in the bill network
delete /v3/network/invitation/customer/\{customerid\}
) before sending a new invitation. note: if the invited customer does not respond to an invitation for 60 days, the invitation expires. see bill network in the guides section for more information, sample requests, and responses.Restore an archived customer
archived
field is set as false
. you can perform any valid bill operation on restored customers. there is no change when you restore a restored customer.Get transaction details
Invite a vendor in the bill network
delete /v3/network/invitation/vendor/\{vendorid\}
) before sending a new invitation. note: if the invited vendor does not respond to an invitation for 60 days, the invitation expires. see bill network in the guides section for more information, sample requests, and responses.Restore an archived bill
archived
field is set as false
. you can perform any valid bill operation on restored bills. there is no change when you restore a restored bill.Restore an archived chart of accounts
archived
field is set as false
.Get list of invoice attachments
downloadlink
in a get request to download the attachment. curl '{downloadlink}&sessionid={session id}' --output {attachment name}
Restore an archived accounting class
archived
field is set as false
.Replace a recurring bill
id
is generated in the bill. * when you omit an existing line item id
, the line item is removed from the bill. when a recurring bill is modified, all future bills are automatically changed.Mfa step up for api session
post /v3/login
, set remembermeid
and device
in your request to generate an mfa-trusted api session. in case you sign in without remembermeid
and device
in your request, you can use this post /v3/mfa/step-up
endpoint to mark the current api session as mfa trusted.Get organization price plan details
administrator
user role in the bill organization to perform this operation. a bill price plan for an organization provides a range of information, including monthly subscription fees and the terms and conditions for additional charges in the price plan.Restore an archived employee
archived
field is set as false
.Restore an archived item
archived
field is set as false
.Restore an archived invoice
archived
field is set as false
. you can perform any valid bill operation on restored invoices. there is no change when you restore a restored invoice.Restore an archived department
archived
field is set as false
.Restore an archived job
archived
field is set as false
.Nominate a bank account user
verificationstatus
is set as nominated
. * bill sends the user an email asking them to sign in to the bill web app and complete identity verification. after user identity verification is successful, the bank account user verificationstatus
is set as verified
and the user can pay with the specified bank account. note: the bank account status
must be set as verified
before you can nominate bank account users.Get user details
Restore an archived recurring bill
archived
field is set as false
. you can perform any valid bill operation on restored recurring bills. there is no change when you restore a restored recurring bill. when a recurring bill is modified, all future bills are automatically changed.Get list of budgets
Restore an archived location
archived
field is set as false
.Get pan jwt
post https://app-dev-sandbox.divvy.co/de/rest/pan
. curl --location --request post 'https://app-dev-sandbox.divvy.co/de/rest/pan' --header 'content-type: application/json' --data-raw '{"token":"{jwt token}"}'
note: use post https://api.divvy.co/de/rest/pan
in the production environment.Get list of items
max
in your request to get up to 100 results on one page. see search operations with lists in the guides section for filtering, sorting, and pagination examples.Get list of cards
Get payment details
Get user role details
Restore an archived user
archived
field is set as false
. you can perform any valid bill operation on restored users. there is no change when you restore a restored user.Restore multiple accounting classes
archived
field for each object is set as false
.Restore multiple chart of accounts
archived
field for each object is set as false
.Record ar payment
Get vendor bank account details
Get phone status for risk verification
hasphone
is false
, you can add a phone number for the user with post /v3/risk-verifications/phone
. after you add a phone number, you can initiate risk verification for the organization with post /v3/risk-verifications
.Search for an organization in the bill networks
name
requirements for getting search results. * your search term must have a minimum of three characters. * your search term must be a complete word. you will not get search results when your search term is a partial word. when you search in the verified national vendor network, search results are based on both a complete and partial match on name
and ziporpostalcode
. you can further filter your search by the billing statement accountnumber
with the vendor. for example, your verizon internet bill account number. see bill network in the guides section for more information, sample requests, and responses.Retrieve customer attachments
Send an invoice
Restore multiple employees
archived
field for each object is set as false
.Restore multiple departments
archived
field is set as false
.Get list of card accounts
Get recurring bill details
Restore multiple locations
archived
field for each object is set as false
.Get vendor configuration
paymentpurpose
and regulatoryfields
information is retrieved for the vendor. note: if you are adding paymentpurpose
and regulatoryfields
information during international vendor creation, use get /v3/vendors/configuration/international-payments
to get the required configuration before vendor creation. see creating an international vendor for more information on how to set paymentpurpose
and regulatoryfields
.Restore multiple items
archived
field for each object is set as false
.Update an employee
Update an accounting class
Get reimbursement details
Update an invoice
amount
, quantity
, and description
. the invoice line item id
does not change with a patch operation.Get list of card account users
verificationstatus
is set as nominated
, user verification must be completed before the user can pay with the specified card account. by default, you get 20 results on one page of results. set max
in your request to get up to 100 results on one page.Update an item
Update an organization
administrator
user role in the bill organization to perform this operation. see organizations and users in the guides section for more information, sample requests, and responses.Get list of ap cards
Update a bank account
status
requirement: the bank account status
must be set as verified
before you can update any details about the bank account. you can verify the bank account with post /v3/funding-accounts/banks/\{bankaccountid\}/verify
. * update field restrictions: you cannot update the routingnumber
, accountnumber
, and account type
values for a bank account. if you want to update any of these values, create a new bank account with post /v3/funding-accounts/banks
.Update a customer
Replace a bill
id
is generated in the bill. * when you omit an existing line item id
, the line item is removed from the bill.Update a chart of accounts
Restore multiple jobs
archived
field for each object is set as false
.Replace an invoice
id
is generated in the invoice. * when you omit an existing line item id
, the line item is removed from the invoice.Update a bill
amount
and description
. the bill line item id
does not change with a patch operation.Get list of bank accounts
max
in your request to get up to 100 results on one page. see search operations with lists in the guides section for filtering, sorting, and pagination examples.Update a budget
Update a custom field and values on a transaction
Get list of jobs
max
in your request to get up to 100 results on one page. see search operations with lists in the guides section for filtering, sorting, and pagination examples.Get list of members for a budget
Get list of accounting classes
max
in your request to get up to 100 results on one page. see search operations with lists in the guides section for filtering, sorting, and pagination examples.Get list of locations
max
in your request to get up to 100 results on one page. see search operations with lists in the guides section for filtering, sorting, and pagination examples.Get list of mfa phone numbers
Get list of user roles
max
in your request to get up to 100 results on one page. see search operations with lists in the guides section for filtering, sorting, and pagination examples.Get list of transactions
Get list of users
max
in your request to get up to 100 results on one page. see search operations with lists in the guides section for filtering, sorting, and pagination examples.Get list of departments
max
in your request to get up to 100 results on one page. see search operations with lists in the guides section for filtering, sorting, and pagination examples.Restore an archived vendor
archived
field is set as false
. you can perform any valid bill operation on restored vendors. there is no change when you restore a restored vendor.Get list of chart of accounts
max
in your request to get up to 100 results on one page. see search operations with lists in the guides section for filtering, sorting, and pagination examples.Get list of customers
max
in your request to get up to 100 results on one page. see search operations with lists in the guides section for filtering, sorting, and pagination examples.Get list of custom fields
Get list of values for custom field
Get list of vendors
max
in your request to get up to 100 results on one page. see search operations with lists in the guides section for filtering, sorting, and pagination examples.Get list of reimbursements
Validate phone for mfa setup
Update budget member funds
Update a job
Upload bill document
get /v3/documents/upload-status
. see documents and attachments in the guides section for more information, sample requests, and responses.Update a department
Update transaction
Update a vendor card
Void a payment
post /v3/payments/\{paymentid\}/cancel
). you can attempt to void payments made both with bill (online) and outside bill (offline). ### void a payment made with bill (online) in your /post /v3/payments/\{paymentid\}/void
request: * set paymentid
as the bill-generated id of the payment. the value begins with stp
. * set type
as the void payment request type * set reason
as the reason for voiding the payment see can i cancel or void a payables payment? in the bill help center to learn about the bill void payment process and timing in the production environment.Update a location
Verify a bank account
Update a vendor
line1
* city
* ziporpostalcode
* country
* payeename
note: you cannot add or update vendor bank account information with this endpoint. you can add and manage vendor bank account information with a dedicated set of endpoints. * create a vendor bank account: post /v3/vendors/\{vendorid\}/bank-account
* get vendor bank account details: get /v3/vendors/\{vendorid\}/bank-account
* delete a vendor bank account: delete /v3/vendors/\{vendorid\}/bank-account
Update a reimbursement
Update custom field details
Update a list of budget members in a budget
Validate mfa challenge
Update a user
Upload invoice attachment
Upload customer attachment
Update a recurring bill
id
does not change with a patch operation. when a recurring bill is modified, all future bills are automatically changed.Upload vendor attachment