Skip to main content

Bill Component

Bill

Use the Bill component to manage Bank Accounts, Invoices, Bills, and more.

Component key: bill

Description​

Bill.com is a leading provider of cloud-based software that simplifies and automates back-office financial operations for small and midsize businesses.

Use the Bill component to manage Bank Accounts, Invoices, Bills, and more.

API Documentation​

The component was built using the Bill API Reference

Connections​

Client Credentials​

The following credentials are needed to authenticate with the BILL API:

  • Username: Your username is the email address used to sign in to your API sandbox developer account.
  • Password: Your password is used to sign in to your API sandbox developer account.
  • Organization ID: Your API sandbox developer account represents your organization in BILL. The organization ID is a unique alphanumeric value that begins with 008.
  • Developer key: Your developer key is used to uniquely identify your developer account in your API requests.

Instructions​

  1. Retrieve Credentials Ensure you have received an email from the BILL team containing your API login information: username, password, organization ID, and developer key.

  2. Configure Prismatic Component Open the configuration settings for your Bill connection and input the credentials.

InputDefaultNotes
Developer Key
string
/ Required
developerKey
Your developer key is used to uniquely identify your developer account in your API requests.
Organization ID
string
/ Required
organizationId
The organization ID is a unique alphanumeric value that begins with 008.
Password
password
/ Required
password
Your password is used to sign in to your API sandbox developer account.
Use Production URL
boolean
useProductionUrl
true
Turn this On to use the production URL. Turn this Off to use the sandbox URL.
Username
string
/ Required
username
Your username is the email address used to sign in to your API sandbox developer account.

Data Sources​

Select Bill​

Select a bill from the list of available bills. | key: selectBill | type: picklist

InputNotes
Connection
connection
/ Required
connection
 

Select Customer​

Select a customer from the list of available customers. | key: selectCustomer | type: picklist

InputNotes
Connection
connection
/ Required
connection
 

Select Customer Bank Account​

Select a customer bank account from the list of available customer bank accounts. | key: selectCustomerBankAccount | type: picklist

InputNotes
Connection
connection
/ Required
connection
 

Select Invoice​

Select an invoice from the list of available invoices. | key: selectInvoice | type: picklist

InputNotes
Connection
connection
/ Required
connection
 

Select Vendor​

Select a vendor from the list of available vendors. | key: selectVendor | type: picklist

InputNotes
Connection
connection
/ Required
connection
 

Select Vendor Bank Account​

Select a vendor bank account from the list of available vendor bank accounts. | key: selectVendorBankAccount | type: picklist

InputNotes
Connection
connection
/ Required
connection
 

Actions​

Authenticate MFA session​

Use this action to authenticate an MFA session. Session only last 30 days. | key: mfaAuthenticate

InputDefaultNotesExample
Challenge ID
string
/ Required
challengeId
The challenge ID received from the 'Generate an MFA challenge ID' action.
!b-KXe8pBDp1vFgjczl...
Connection
connection
/ Required
connection
 
 
 
Debug Request
boolean
debug
false
Enabling this flag will log out the current request.
 
Session ID
string
/ Required
sessionId
The session ID received from the 'Generate an MFA challenge ID' action.
 
Code Token
string
/ Required
token
The MFA code token received at the user's device.
987123

{
  "data": {
    "machineName": "Prismatic Instace",
    "mfaId": "!b_EJCd_jPIsZYT5bxk9QG2oXP2TvQwGjeSzWFeZt-wy9gi03A2U8Uvj_cZDhCDBde",
    "deviceId": "Prismatic-BillMFA"
  }
}

Bulk Create Bills​

Bulk create bill objects. | key: bulkCreateBills

InputDefaultNotesExample
Bills to Create
code
/ Required
billsCreateBulk
An array of bill objects to create. See https://developer.bill.com/reference/ap-vendortransactions-bulkcreatebill for more information. Go to Prismatic docs to see an example of how to use this input.
Connection
connection
/ Required
connection
 
 
 
Debug Request
boolean
debug
false
Enabling this flag will log out the current request.
 

{
  "data": {
    "bulk": [
      {
        "response_status": 0,
        "response_message": "Success",
        "response_data": {
          "entity": "Bill",
          "id": "00n02XNWHOPPXWV9ewx0",
          "isActive": "1",
          "vendorId": "00902YSHZXAKZHY25m0r",
          "invoiceNumber": "01",
          "approvalStatus": "0",
          "invoiceDate": "2024-07-01",
          "dueDate": "2024-08-01",
          "glPostingDate": "2024-07-01",
          "amount": 1,
          "localAmount": null,
          "exchangeRate": null,
          "scheduledAmount": 0,
          "paidAmount": null,
          "dueAmount": 1,
          "creditAmount": 0,
          "paymentStatus": "1",
          "uiPaymentStatus": "1",
          "description": null,
          "poNumber": null,
          "createdTime": "2024-07-30T23:00:32.000+0000",
          "updatedTime": "2024-07-30T23:00:32.000+0000",
          "createdBy": "00602ZGNAZQYJBKLdrql",
          "payFromBankAccountId": "00000000000000000000",
          "payFromChartOfAccountId": "00000000000000000000",
          "paymentTermId": "00000000000000000000",
          "hasAutoPay": false,
          "eBillCreated": false,
          "invoiceProductId": "00000000000000000000",
          "chartOfAccountId": "00000000000000000000",
          "departmentId": "00000000000000000000",
          "locationId": "00000000000000000000",
          "actgClassId": "00000000000000000000",
          "source": "0",
          "numApprPolicyEx": 0,
          "useBillDesc": false,
          "defaultInvoiceNumber": false,
          "isAutoSaved": false,
          "billTemplateId": "00000000000000000000",
          "quickbooksId": null,
          "lastPaymentDate": null,
          "fullPaymentDate": null,
          "hasLinkedPurchaseOrders": false,
          "multipleBillLineItems": false,
          "item": {
            "count": 0,
            "totalAmount": 0
          },
          "expense": {
            "count": 1,
            "totalAmount": 1,
            "chartOfAccountGroup": []
          },
          "billLineItems": [
            {
              "entity": "BillLineItem",
              "id": "bli02VSXIUDVFUQd1e4s",
              "billId": "00n02XNWHOPPXWV9ewx0",
              "amount": 1,
              "chartOfAccountId": "00000000000000000000",
              "departmentId": "00000000000000000000",
              "locationId": "00000000000000000000",
              "jobId": "00000000000000000000",
              "customerId": "00000000000000000000",
              "jobBillable": false,
              "description": null,
              "createdTime": "2024-07-30T23:00:32.000+0000",
              "updatedTime": "2024-07-30T23:00:32.000+0000",
              "lineType": "1",
              "itemId": "00000000000000000000",
              "quantity": null,
              "unitPrice": null,
              "employeeId": "00000000000000000000",
              "actgClassId": "00000000000000000000",
              "purchaseOrderBillLinkId": "00000000000000000000",
              "unitOfMeasureId": "00000000000000000000",
              "lineOrder": 0
            }
          ]
        }
      }
    ]
  }
}

Bulk Create Customers​

Bulk create customer objects. | key: bulkCreateCustomers

InputDefaultNotesExample
Connection
connection
/ Required
connection
 
 
 
Customers to Create
code
/ Required
customersCreateBulk
An array of customer objects to create. See https://developer.bill.com/reference/ar-customermgmt-bulkcreatecustomer for more information. Go to Prismatic docs to see an example of how to use this input.
Debug Request
boolean
debug
false
Enabling this flag will log out the current request.
 

{
  "data": {
    "bulk": [
      {
        "response_status": 0,
        "response_message": "Success",
        "response_data": {
          "entity": "Customer",
          "id": "0cu02EAQUAPCBNTDsmzc",
          "isActive": "1",
          "createdTime": "2024-07-29T20:30:30.000+0000",
          "updatedTime": "2024-07-30T19:14:48.000+0000",
          "name": "John",
          "shortName": null,
          "parentCustomerId": "00000000000000000000",
          "companyName": "A Company",
          "contactFirstName": "John",
          "contactLastName": "Doe",
          "accNumber": null,
          "billAddress1": null,
          "billAddress2": null,
          "billAddress3": null,
          "billAddress4": null,
          "billAddressCity": null,
          "billAddressState": null,
          "billAddressCountry": null,
          "billAddressZip": null,
          "shipAddress1": null,
          "shipAddress2": null,
          "shipAddress3": null,
          "shipAddress4": null,
          "shipAddressCity": null,
          "shipAddressState": null,
          "shipAddressCountry": null,
          "shipAddressZip": null,
          "email": null,
          "phone": null,
          "altPhone": null,
          "fax": null,
          "description": null,
          "invoiceCurrency": null,
          "printAs": null,
          "mergedIntoId": "00000000000000000000",
          "hasAuthorizedToCharge": false,
          "accountType": "0",
          "paymentTermId": "00000000000000000000",
          "balance": 0,
          "availCredit": 0,
          "taxId": null,
          "hasBankAccount": false,
          "hasNetBankAccount": false,
          "hasBankAccountAutoPay": false,
          "hasCreditCard": false,
          "hasCreditCardAutoPay": false,
          "defaultDeliveryMethod": null,
          "isAutoChargeDismissed": false,
          "isTaxLiable": false,
          "creationSource": "0",
          "enabledInvoiceFinancing": false,
          "hasCustomerCard": false,
          "enabledAutoInvoiceFinancing": false
        }
      }
    ]
  }
}

Bulk Create Invoices​

Bulk create invoice objects. | key: bulkCreateInvoices

InputDefaultNotesExample
Connection
connection
/ Required
connection
 
 
 
Debug Request
boolean
debug
false
Enabling this flag will log out the current request.
 
Invoices to Create
code
/ Required
invoiceCreateBulk
An array of invoice objects to create. See https://developer.bill.com/reference/ar-customertransactions-bulkcreateinvoice for more information. Go to Prismatic docs to see an example of how to use this input.

{
  "data": {
    "bulk": [
      {
        "response_status": 0,
        "response_message": "Success",
        "response_data": {
          "entity": "Invoice",
          "id": "00e02DTFJUMHHRGKh6zx",
          "isActive": "1",
          "createdBy": "00602ZGNAZQYJBKLdrql",
          "createdTime": "2024-07-31T16:56:53.000+0000",
          "updatedTime": "2024-07-31T20:27:48.000+0000",
          "customerId": "0cu02BLGFCGXROGGsnpx",
          "invoiceNumber": "001",
          "invoiceDate": "2024-07-22",
          "dueDate": "2024-09-08",
          "glPostingDate": "2024-07-22",
          "amount": 2199,
          "localAmount": null,
          "exchangeRate": null,
          "amountDue": 2199,
          "paymentStatus": "1",
          "description": null,
          "poNumber": null,
          "isToBePrinted": false,
          "isToBeEmailed": false,
          "lastSentTime": null,
          "itemSalesTax": "0ii02JKMRQWBGLFLadj8",
          "salesTaxPercentage": 6,
          "salesTaxTotal": 0,
          "terms": "Due upon receipt",
          "salesRep": null,
          "FOB": null,
          "shipDate": null,
          "shipMethod": null,
          "departmentId": "00000000000000000000",
          "locationId": "00000000000000000000",
          "actgClassId": "00000000000000000000",
          "jobId": "00000000000000000000",
          "payToBankAccountId": "00000000000000000000",
          "payToChartOfAccountId": "00000000000000000000",
          "invoiceTemplateId": "itm02EJBDDIGUVGSc8w1",
          "hasAutoPay": false,
          "source": "0",
          "emailDeliveryOption": "1",
          "mailDeliveryOption": "0",
          "creditAmount": 0,
          "quickbooksId": null,
          "recInvoiceTemplateId": "00000000000000000000",
          "financingStatus": "0",
          "netBillId": "00000000000000000000",
          "netOrgId": "00000000000000000000",
          "scheduledAmount": 0,
          "stylingId": null,
          "stylingRevision": null,
          "financingModelStatus": null,
          "financingErrorType": "0",
          "invoiceLineItems": [
            {
              "entity": "InvoiceLineItem",
              "id": "00f02QSSEGYTPEZDeik8",
              "createdTime": "2024-07-31T20:27:48.000+0000",
              "updatedTime": "2024-07-31T20:27:48.000+0000",
              "invoiceId": "00e02DTFJUMHHRGKh6zx",
              "itemId": "0ii02CTRVHZJQMRWad60",
              "quantity": 1,
              "amount": 12,
              "price": 12,
              "serviceDate": null,
              "ratePercent": null,
              "chartOfAccountId": "00000000000000000000",
              "departmentId": "00000000000000000000",
              "locationId": "00000000000000000000",
              "actgClassId": "00000000000000000000",
              "jobId": "00000000000000000000",
              "description": null,
              "taxable": false,
              "taxCode": "Non",
              "lineOrder": 0
            }
          ],
          "invoiceAdjustments": [],
          "invoiceCustomFields": []
        }
      }
    ]
  }
}

Bulk Create Vendor​

Bulk create vendor objects. | key: bulkCreateVendor

InputDefaultNotesExample
Connection
connection
/ Required
connection
 
 
 
Debug Request
boolean
debug
false
Enabling this flag will log out the current request.
 
Vendors to Create
code
/ Required
vendorCreateBulk
An array of vendor objects to create. See https://developer.bill.com/reference/ap-vendormgmt-bulkcreatevendor for more information. Go to Prismatic docs to see an example of how to use this input.

{
  "data": {
    "bulk": [
      {
        "response_status": 0,
        "response_message": "Success",
        "response_data": {
          "entity": "Vendor",
          "id": "00902YSABCAKZHY25m0r",
          "isActive": "1",
          "name": "Prismatic Vendor",
          "shortName": null,
          "nameOnCheck": "Prismatic Vendor",
          "companyName": "Prismatic",
          "accNumber": null,
          "taxId": null,
          "taxIdType": null,
          "track1099": false,
          "address1": null,
          "address2": null,
          "address3": null,
          "address4": null,
          "addressCity": null,
          "addressState": null,
          "addressZip": null,
          "addressCountry": null,
          "email": "example@email.com",
          "fax": null,
          "phone": null,
          "payBy": "0",
          "paymentEmail": null,
          "paymentPhone": null,
          "description": null,
          "createdTime": "2024-07-30T19:31:00.000+0000",
          "updatedTime": "2024-07-30T19:31:00.000+0000",
          "contactFirstName": null,
          "contactLastName": null,
          "mergedIntoId": "00000000000000000000",
          "accountType": "0",
          "paymentTermId": "00000000000000000000",
          "sendNotifications": true,
          "balance": 0,
          "availCredit": 0,
          "lastBalanceUpdate": null,
          "externalBillPayIn12m": null,
          "since": null,
          "payDaysBefore": null,
          "enabledCombinePayments": true,
          "hasBankAccountAutoPay": false,
          "hasRecurringPayments": false,
          "billCurrency": "USD",
          "billSyncPref": "0",
          "paymentCurrency": null,
          "prefPmtMethod": "1",
          "paymentPurpose": null,
          "bankCountry": null,
          "vendorBankAccountStatus": -1,
          "sendInviteForPrivateVendor": true,
          "vendorVCardRemitEmail": null,
          "vendorVCardStatus": "-1",
          "orgVCardStatus": "1",
          "prefRemitEmail": "0",
          "remitEmail": null,
          "processorVCardStatus": null,
          "vStatusUpdateSource": null,
          "allowConnectedVendorEditAddress": false,
          "informConnectedVendorAddressSyncModified": false,
          "intlPaymentType": "0",
          "vcardEnrollDate": null,
          "vcardDeclineDate": null,
          "isAccountNumberRequired": false,
          "largeBillerId": "00000000000000000000",
          "orgVCardOptOutCustReason": null,
          "enableFundedInvite": false,
          "lastPaymentDate": null,
          "numberOfInvitesSent": 0,
          "eligibleForEbills": false,
          "acknowledgedEbillBanner": false,
          "acknowledgedEbillError": false,
          "eBillEnablementFailed": false,
          "PaymentusMerchantId": null,
          "unmodifiedBillsCount": 0,
          "setupAutoPayPrompt": false,
          "autoPayConflict": false,
          "nameOnCheckRemediation": false,
          "autoSave": null,
          "autoSaveStatus": null,
          "creationSource": "0",
          "PaymentusPmtType": null,
          "PaymentusAcctToken": null,
          "PaymentusAcctToken2": null,
          "PaymentusAcctToken3": null,
          "stpProcessor": "0",
          "eBillEnabledStatus": "0",
          "orgVCardOptOutCustOther": null,
          "networkStatus": null,
          "vcardProcessor": "1",
          "isAddressValidated": false,
          "isSyncVendorCountryMapped": false,
          "optedOutOfVCardByOrg": false,
          "invalidCountryCurrencyAtNewVendorSync": false,
          "acctBalance": 0,
          "lastAcctBalanceUpdate": null,
          "paymentEmails": null,
          "eBillEligible": false,
          "required": []
        }
      }
    ]
  }
}

Bulk Create Vendor Bank Accounts​

Bulk create vendor bank account objects. | key: bulkCreateVendorBankAccounts

InputDefaultNotesExample
Connection
connection
/ Required
connection
 
 
 
Debug Request
boolean
debug
false
Enabling this flag will log out the current request.
 
Device ID
string
/ Required
deviceId
ID of the device. Retrieved from the 'Authenticate MFA session' action.
Prismatic-...
MFA ID
string
/ Required
mfaId
ID of the MFA. Retrieved from the 'Authenticate MFA session' action.
!b_EJCd_jPIsZYT...
Vendor Bank Accounts to Create
code
/ Required
vendorBankAccountCreateBulk
An array of vendor bank account objects to create. See https://developer.bill.com/reference/ap-vendormgmt-bulkcreatevendorbankaccount for more information. Go to Prismatic docs to see an example of how to use this input.

{
  "data": {
    "bulk": [
      {
        "response_status": 0,
        "response_message": "Success",
        "response_data": {
          "entity": "VendorBankAccount",
          "id": "vba02BSNHVJVZPN17kxr",
          "isActive": "1",
          "createdTime": "2024-07-30T20:33:28.000+0000",
          "updatedTime": "2024-07-30T20:33:28.000+0000",
          "vendorId": "00902JIJYMCGEGI25m2l",
          "nameOnAcct": "John Doe",
          "accountNumber": "******7890",
          "routingNumber": "021000021",
          "usersId": "00602ZGNAZQYJBKLdrql",
          "status": "1",
          "isSavings": false,
          "isPersonalAcct": false,
          "intlEPaymentAcct": false,
          "intlPaymentType": "0",
          "paymentCurrency": null,
          "bankCountry": null,
          "vendorBankData": null,
          "bankAddSource": "2",
          "intlTemplateKey": null,
          "regulatory1": null,
          "regulatory2": null,
          "regulatory3": null,
          "regulatory4": null,
          "regulatory5": null,
          "regulatory6": null,
          "regulatory7": null
        }
      }
    ]
  }
}

Bulk Update Bills​

Bulk update bill objects. | key: bulkUpdateBills

InputDefaultNotesExample
Bills to Update
code
/ Required
billsUpdateBulk
An array of bill objects to update. See https://developer.bill.com/reference/ap-vendortransactions-bulkupdatebill for more information. Go to Prismatic docs to see an example of how to use this input.
Connection
connection
/ Required
connection
 
 
 
Debug Request
boolean
debug
false
Enabling this flag will log out the current request.
 

{
  "data": {
    "bulk": [
      {
        "response_status": 0,
        "response_message": "Success",
        "response_data": {
          "entity": "Bill",
          "id": "00n02XNWHOPPXWV9ewx0",
          "isActive": "1",
          "vendorId": "00902YSHZXAKZHY25m0r",
          "invoiceNumber": "01",
          "approvalStatus": "0",
          "invoiceDate": "2024-07-01",
          "dueDate": "2024-08-01",
          "glPostingDate": "2024-07-01",
          "amount": 1,
          "localAmount": null,
          "exchangeRate": null,
          "scheduledAmount": 0,
          "paidAmount": null,
          "dueAmount": 1,
          "creditAmount": 0,
          "paymentStatus": "1",
          "uiPaymentStatus": "1",
          "description": null,
          "poNumber": null,
          "createdTime": "2024-07-30T23:00:32.000+0000",
          "updatedTime": "2024-07-30T23:00:32.000+0000",
          "createdBy": "00602ZGNAZQYJBKLdrql",
          "payFromBankAccountId": "00000000000000000000",
          "payFromChartOfAccountId": "00000000000000000000",
          "paymentTermId": "00000000000000000000",
          "hasAutoPay": false,
          "eBillCreated": false,
          "invoiceProductId": "00000000000000000000",
          "chartOfAccountId": "00000000000000000000",
          "departmentId": "00000000000000000000",
          "locationId": "00000000000000000000",
          "actgClassId": "00000000000000000000",
          "source": "0",
          "numApprPolicyEx": 0,
          "useBillDesc": false,
          "defaultInvoiceNumber": false,
          "isAutoSaved": false,
          "billTemplateId": "00000000000000000000",
          "quickbooksId": null,
          "lastPaymentDate": null,
          "fullPaymentDate": null,
          "hasLinkedPurchaseOrders": false,
          "multipleBillLineItems": false,
          "item": {
            "count": 0,
            "totalAmount": 0
          },
          "expense": {
            "count": 1,
            "totalAmount": 1,
            "chartOfAccountGroup": []
          },
          "billLineItems": [
            {
              "entity": "BillLineItem",
              "id": "bli02VSXIUDVFUQd1e4s",
              "billId": "00n02XNWHOPPXWV9ewx0",
              "amount": 1,
              "chartOfAccountId": "00000000000000000000",
              "departmentId": "00000000000000000000",
              "locationId": "00000000000000000000",
              "jobId": "00000000000000000000",
              "customerId": "00000000000000000000",
              "jobBillable": false,
              "description": null,
              "createdTime": "2024-07-30T23:00:32.000+0000",
              "updatedTime": "2024-07-30T23:00:32.000+0000",
              "lineType": "1",
              "itemId": "00000000000000000000",
              "quantity": null,
              "unitPrice": null,
              "employeeId": "00000000000000000000",
              "actgClassId": "00000000000000000000",
              "purchaseOrderBillLinkId": "00000000000000000000",
              "unitOfMeasureId": "00000000000000000000",
              "lineOrder": 0
            }
          ]
        }
      }
    ]
  }
}

Bulk Update Customers​

Bulk update customer objects. | key: bulkUpdateCustomers

InputDefaultNotesExample
Connection
connection
/ Required
connection
 
 
 
Customers to Update
code
/ Required
customersUpdateBulk
An array of customer objects to update. See https://developer.bill.com/reference/ar-customermgmt-bulkupdatecustomer for more information. Go to Prismatic docs to see an example of how to use this input.
Debug Request
boolean
debug
false
Enabling this flag will log out the current request.
 

{
  "data": {
    "bulk": [
      {
        "response_status": 0,
        "response_message": "Success",
        "response_data": {
          "entity": "Customer",
          "id": "0cu02EAQUAPCBNTDsmzc",
          "isActive": "1",
          "createdTime": "2024-07-29T20:30:30.000+0000",
          "updatedTime": "2024-07-30T19:14:48.000+0000",
          "name": "John",
          "shortName": null,
          "parentCustomerId": "00000000000000000000",
          "companyName": "A Company",
          "contactFirstName": "John",
          "contactLastName": "Doe",
          "accNumber": null,
          "billAddress1": null,
          "billAddress2": null,
          "billAddress3": null,
          "billAddress4": null,
          "billAddressCity": null,
          "billAddressState": null,
          "billAddressCountry": null,
          "billAddressZip": null,
          "shipAddress1": null,
          "shipAddress2": null,
          "shipAddress3": null,
          "shipAddress4": null,
          "shipAddressCity": null,
          "shipAddressState": null,
          "shipAddressCountry": null,
          "shipAddressZip": null,
          "email": null,
          "phone": null,
          "altPhone": null,
          "fax": null,
          "description": null,
          "invoiceCurrency": null,
          "printAs": null,
          "mergedIntoId": "00000000000000000000",
          "hasAuthorizedToCharge": false,
          "accountType": "0",
          "paymentTermId": "00000000000000000000",
          "balance": 0,
          "availCredit": 0,
          "taxId": null,
          "hasBankAccount": false,
          "hasNetBankAccount": false,
          "hasBankAccountAutoPay": false,
          "hasCreditCard": false,
          "hasCreditCardAutoPay": false,
          "defaultDeliveryMethod": null,
          "isAutoChargeDismissed": false,
          "isTaxLiable": false,
          "creationSource": "0",
          "enabledInvoiceFinancing": false,
          "hasCustomerCard": false,
          "enabledAutoInvoiceFinancing": false
        }
      }
    ]
  }
}

Bulk Update Invoices​

Bulk update invoice objects. | key: bulkUpdateInvoices

InputDefaultNotesExample
Connection
connection
/ Required
connection
 
 
 
Debug Request
boolean
debug
false
Enabling this flag will log out the current request.
 
Invoices to Update
code
/ Required
invoiceUpdateBulk
An array of invoice objects to update. See https://developer.bill.com/reference/ar-customertransactions-bulkupdateinvoice for more information. Go to Prismatic docs to see an example of how to use this input.

{
  "data": {
    "bulk": [
      {
        "response_status": 0,
        "response_message": "Success",
        "response_data": {
          "entity": "Invoice",
          "id": "00e02DTFJUMHHRGKh6zx",
          "isActive": "1",
          "createdBy": "00602ZGNAZQYJBKLdrql",
          "createdTime": "2024-07-31T16:56:53.000+0000",
          "updatedTime": "2024-07-31T20:27:48.000+0000",
          "customerId": "0cu02BLGFCGXROGGsnpx",
          "invoiceNumber": "001",
          "invoiceDate": "2024-07-22",
          "dueDate": "2024-09-08",
          "glPostingDate": "2024-07-22",
          "amount": 2199,
          "localAmount": null,
          "exchangeRate": null,
          "amountDue": 2199,
          "paymentStatus": "1",
          "description": null,
          "poNumber": null,
          "isToBePrinted": false,
          "isToBeEmailed": false,
          "lastSentTime": null,
          "itemSalesTax": "0ii02JKMRQWBGLFLadj8",
          "salesTaxPercentage": 6,
          "salesTaxTotal": 0,
          "terms": "Due upon receipt",
          "salesRep": null,
          "FOB": null,
          "shipDate": null,
          "shipMethod": null,
          "departmentId": "00000000000000000000",
          "locationId": "00000000000000000000",
          "actgClassId": "00000000000000000000",
          "jobId": "00000000000000000000",
          "payToBankAccountId": "00000000000000000000",
          "payToChartOfAccountId": "00000000000000000000",
          "invoiceTemplateId": "itm02EJBDDIGUVGSc8w1",
          "hasAutoPay": false,
          "source": "0",
          "emailDeliveryOption": "1",
          "mailDeliveryOption": "0",
          "creditAmount": 0,
          "quickbooksId": null,
          "recInvoiceTemplateId": "00000000000000000000",
          "financingStatus": "0",
          "netBillId": "00000000000000000000",
          "netOrgId": "00000000000000000000",
          "scheduledAmount": 0,
          "stylingId": null,
          "stylingRevision": null,
          "financingModelStatus": null,
          "financingErrorType": "0",
          "invoiceLineItems": [
            {
              "entity": "InvoiceLineItem",
              "id": "00f02QSSEGYTPEZDeik8",
              "createdTime": "2024-07-31T20:27:48.000+0000",
              "updatedTime": "2024-07-31T20:27:48.000+0000",
              "invoiceId": "00e02DTFJUMHHRGKh6zx",
              "itemId": "0ii02CTRVHZJQMRWad60",
              "quantity": 1,
              "amount": 12,
              "price": 12,
              "serviceDate": null,
              "ratePercent": null,
              "chartOfAccountId": "00000000000000000000",
              "departmentId": "00000000000000000000",
              "locationId": "00000000000000000000",
              "actgClassId": "00000000000000000000",
              "jobId": "00000000000000000000",
              "description": null,
              "taxable": false,
              "taxCode": "Non",
              "lineOrder": 0
            }
          ],
          "invoiceAdjustments": [],
          "invoiceCustomFields": []
        }
      }
    ]
  }
}

Bulk Update Vendors​

Bulk update vendor objects. | key: bulkUpdateVendors

InputDefaultNotesExample
Connection
connection
/ Required
connection
 
 
 
Debug Request
boolean
debug
false
Enabling this flag will log out the current request.
 
Vendors to Update
code
/ Required
vendorUpdateBulk
An array of vendor objects to update. See https://developer.bill.com/reference/ap-vendormgmt-bulkupdatevendor for more information. Go to Prismatic docs to see an example of how to use this input.

{
  "data": {
    "bulk": [
      {
        "response_status": 0,
        "response_message": "Success",
        "response_data": {
          "entity": "Vendor",
          "id": "00902YSABCAKZHY25m0r",
          "isActive": "1",
          "name": "Prismatic Vendor",
          "shortName": null,
          "nameOnCheck": "Prismatic Vendor",
          "companyName": "Prismatic",
          "accNumber": null,
          "taxId": null,
          "taxIdType": null,
          "track1099": false,
          "address1": null,
          "address2": null,
          "address3": null,
          "address4": null,
          "addressCity": null,
          "addressState": null,
          "addressZip": null,
          "addressCountry": null,
          "email": "example@email.com",
          "fax": null,
          "phone": null,
          "payBy": "0",
          "paymentEmail": null,
          "paymentPhone": null,
          "description": null,
          "createdTime": "2024-07-30T19:31:00.000+0000",
          "updatedTime": "2024-07-30T19:31:00.000+0000",
          "contactFirstName": null,
          "contactLastName": null,
          "mergedIntoId": "00000000000000000000",
          "accountType": "0",
          "paymentTermId": "00000000000000000000",
          "sendNotifications": true,
          "balance": 0,
          "availCredit": 0,
          "lastBalanceUpdate": null,
          "externalBillPayIn12m": null,
          "since": null,
          "payDaysBefore": null,
          "enabledCombinePayments": true,
          "hasBankAccountAutoPay": false,
          "hasRecurringPayments": false,
          "billCurrency": "USD",
          "billSyncPref": "0",
          "paymentCurrency": null,
          "prefPmtMethod": "1",
          "paymentPurpose": null,
          "bankCountry": null,
          "vendorBankAccountStatus": -1,
          "sendInviteForPrivateVendor": true,
          "vendorVCardRemitEmail": null,
          "vendorVCardStatus": "-1",
          "orgVCardStatus": "1",
          "prefRemitEmail": "0",
          "remitEmail": null,
          "processorVCardStatus": null,
          "vStatusUpdateSource": null,
          "allowConnectedVendorEditAddress": false,
          "informConnectedVendorAddressSyncModified": false,
          "intlPaymentType": "0",
          "vcardEnrollDate": null,
          "vcardDeclineDate": null,
          "isAccountNumberRequired": false,
          "largeBillerId": "00000000000000000000",
          "orgVCardOptOutCustReason": null,
          "enableFundedInvite": false,
          "lastPaymentDate": null,
          "numberOfInvitesSent": 0,
          "eligibleForEbills": false,
          "acknowledgedEbillBanner": false,
          "acknowledgedEbillError": false,
          "eBillEnablementFailed": false,
          "PaymentusMerchantId": null,
          "unmodifiedBillsCount": 0,
          "setupAutoPayPrompt": false,
          "autoPayConflict": false,
          "nameOnCheckRemediation": false,
          "autoSave": null,
          "autoSaveStatus": null,
          "creationSource": "0",
          "PaymentusPmtType": null,
          "PaymentusAcctToken": null,
          "PaymentusAcctToken2": null,
          "PaymentusAcctToken3": null,
          "stpProcessor": "0",
          "eBillEnabledStatus": "0",
          "orgVCardOptOutCustOther": null,
          "networkStatus": null,
          "vcardProcessor": "1",
          "isAddressValidated": false,
          "isSyncVendorCountryMapped": false,
          "optedOutOfVCardByOrg": false,
          "invalidCountryCurrencyAtNewVendorSync": false,
          "acctBalance": 0,
          "lastAcctBalanceUpdate": null,
          "paymentEmails": null,
          "eBillEligible": false,
          "required": []
        }
      }
    ]
  }
}

Create Bill​

Create a bill object. | key: createBill

InputDefaultNotesExample
Additional Fields
code
additionalFields
Additional fields that might not be covered by the standard inputs. See https://developer.bill.com/reference/ap-vendortransactions-createbill for more information. Go to Prismatic docs to see an example of how to use this input.
Allow Duplicate Invoice Number
boolean
allowDuplicateInvNum
false
Allow duplicate invoice numbers.
 
Bill Line Items
code
/ Required
billLineItems
An array of bill line items. See https://developer.bill.com/reference/ap-vendortransactions-createbill for more information. Go to Prismatic docs to see an example of how to use this input.
Connection
connection
/ Required
connection
 
 
 
Debug Request
boolean
debug
false
Enabling this flag will log out the current request.
 
Due Date
string
/ Required
dueDate
Date when the bill is due. The value is in the YYYY-MM-DD format.
2021-01-01
Invoice Date
string
/ Required
invoiceDate
Date when the bill is sent. This value is in the YYYY-MM-DD format.
2021-01-01
Invoice Number
string
/ Required
invoiceNumber
User-generated invoice number. This value can be your chosen number scheme or bill due date.
01
Vendor ID
string
/ Required
vendorId
ID of the vendor.
009...

{
  "data": {
    "entity": "Bill",
    "id": "00n02XNWHOPPXWV9ewx0",
    "isActive": "1",
    "vendorId": "00902YSHZXAKZHY25m0r",
    "invoiceNumber": "01",
    "approvalStatus": "0",
    "invoiceDate": "2024-07-01",
    "dueDate": "2024-08-01",
    "glPostingDate": "2024-07-01",
    "amount": 1,
    "localAmount": null,
    "exchangeRate": null,
    "scheduledAmount": 0,
    "paidAmount": null,
    "dueAmount": 1,
    "creditAmount": 0,
    "paymentStatus": "1",
    "uiPaymentStatus": "1",
    "description": null,
    "poNumber": null,
    "createdTime": "2024-07-30T23:00:32.000+0000",
    "updatedTime": "2024-07-30T23:00:32.000+0000",
    "createdBy": "00602ZGNAZQYJBKLdrql",
    "payFromBankAccountId": "00000000000000000000",
    "payFromChartOfAccountId": "00000000000000000000",
    "paymentTermId": "00000000000000000000",
    "hasAutoPay": false,
    "eBillCreated": false,
    "invoiceProductId": "00000000000000000000",
    "chartOfAccountId": "00000000000000000000",
    "departmentId": "00000000000000000000",
    "locationId": "00000000000000000000",
    "actgClassId": "00000000000000000000",
    "source": "0",
    "numApprPolicyEx": 0,
    "useBillDesc": false,
    "defaultInvoiceNumber": false,
    "isAutoSaved": false,
    "billTemplateId": "00000000000000000000",
    "quickbooksId": null,
    "lastPaymentDate": null,
    "fullPaymentDate": null,
    "hasLinkedPurchaseOrders": false,
    "multipleBillLineItems": false,
    "item": {
      "count": 0,
      "totalAmount": 0
    },
    "expense": {
      "count": 1,
      "totalAmount": 1,
      "chartOfAccountGroup": []
    },
    "billLineItems": [
      {
        "entity": "BillLineItem",
        "id": "bli02VSXIUDVFUQd1e4s",
        "billId": "00n02XNWHOPPXWV9ewx0",
        "amount": 1,
        "chartOfAccountId": "00000000000000000000",
        "departmentId": "00000000000000000000",
        "locationId": "00000000000000000000",
        "jobId": "00000000000000000000",
        "customerId": "00000000000000000000",
        "jobBillable": false,
        "description": null,
        "createdTime": "2024-07-30T23:00:32.000+0000",
        "updatedTime": "2024-07-30T23:00:32.000+0000",
        "lineType": "1",
        "itemId": "00000000000000000000",
        "quantity": null,
        "unitPrice": null,
        "employeeId": "00000000000000000000",
        "actgClassId": "00000000000000000000",
        "purchaseOrderBillLinkId": "00000000000000000000",
        "unitOfMeasureId": "00000000000000000000",
        "lineOrder": 0
      }
    ]
  }
}

Create Customer​

Create a customer object. | key: createCustomer

InputDefaultNotesExample
Additional Fields
code
additionalFields
Additional fields that might not be covered by the standard inputs. See https://developer.bill.com/reference/ar-customermgmt-createcustomer for more information. Go to Prismatic docs to see an example of how to use this input.
Connection
connection
/ Required
connection
 
 
 
Customer Name
string
/ Required
customerName
The name of the customer.
John
Debug Request
boolean
debug
false
Enabling this flag will log out the current request.
 

{
  "data": {
    "entity": "Customer",
    "id": "0cu02EAQUAPCBNTDsmzc",
    "isActive": "1",
    "createdTime": "2024-07-29T20:30:30.000+0000",
    "updatedTime": "2024-07-30T19:14:48.000+0000",
    "name": "John",
    "shortName": null,
    "parentCustomerId": "00000000000000000000",
    "companyName": "A Company",
    "contactFirstName": "John",
    "contactLastName": "Doe",
    "accNumber": null,
    "billAddress1": null,
    "billAddress2": null,
    "billAddress3": null,
    "billAddress4": null,
    "billAddressCity": null,
    "billAddressState": null,
    "billAddressCountry": null,
    "billAddressZip": null,
    "shipAddress1": null,
    "shipAddress2": null,
    "shipAddress3": null,
    "shipAddress4": null,
    "shipAddressCity": null,
    "shipAddressState": null,
    "shipAddressCountry": null,
    "shipAddressZip": null,
    "email": null,
    "phone": null,
    "altPhone": null,
    "fax": null,
    "description": null,
    "invoiceCurrency": null,
    "printAs": null,
    "mergedIntoId": "00000000000000000000",
    "hasAuthorizedToCharge": false,
    "accountType": "0",
    "paymentTermId": "00000000000000000000",
    "balance": 0,
    "availCredit": 0,
    "taxId": null,
    "hasBankAccount": false,
    "hasNetBankAccount": false,
    "hasBankAccountAutoPay": false,
    "hasCreditCard": false,
    "hasCreditCardAutoPay": false,
    "defaultDeliveryMethod": null,
    "isAutoChargeDismissed": false,
    "isTaxLiable": false,
    "creationSource": "0",
    "enabledInvoiceFinancing": false,
    "hasCustomerCard": false,
    "enabledAutoInvoiceFinancing": false
  }
}

Create Customer Bank Account​

Create a customer bank account object. | key: createCustomerBankAccount

InputDefaultNotesExample
Account Number
string
/ Required
accountNumber
Customer bank account number.
0112345678
Additional Fields
code
additionalFields
Additional fields that might not be covered by the standard inputs. See https://developer.bill.com/reference/ar-customermgmt-createcustomerbankaccount for more information. Go to Prismatic docs to see an example of how to use this input.
Agreed with TOS
boolean
agreedWithTOS
true
Agreed with the BILL Payment Terms Of Service.
 
Connection
connection
/ Required
connection
 
 
 
Customer ID
string
/ Required
customerId
ID of the customer.
0cu...
Debug Request
boolean
debug
false
Enabling this flag will log out the current request.
 
Name on Account
string
/ Required
nameOnAccount
Customer bank account name.
Account Name
Routing Number
string
/ Required
routingNumber
Customer bank routing number.
012345678

{
  "data": {
    "entity": "CustomerBankAccount",
    "id": "cba02ILJVKOLFVLB6gqr",
    "isActive": "1",
    "createdTime": "2024-07-31T05:10:12.000+0000",
    "updatedTime": "2024-07-31T05:17:36.000+0000",
    "customerId": "0cu02BLGFCGXROGGsnpx",
    "nameOnAccount": "Test",
    "nickname": "Test",
    "routingNumber": "011401533",
    "accountNumber": "******7890",
    "isLockedByOrg": false,
    "isSavings": false,
    "isPersonalAcct": false,
    "isWrittenAuth": false,
    "isPrivate": false,
    "phone": null,
    "cpUserId": "00000000000000000000",
    "status": "1",
    "rndDepExpireDate": "2024-08-13"
  }
}

Create Invoice​

Create an invoice object. | key: createInvoice

InputDefaultNotesExample
Additional Fields
code
additionalFields
Additional fields that might not be covered by the standard inputs. See https://developer.bill.com/reference/ar-customertransactions-createinvoice for more information. Go to Prismatic docs to see an example of how to use this input.
Connection
connection
/ Required
connection
 
 
 
Customer ID
string
/ Required
customerId
ID of the customer.
0cu...
Debug Request
boolean
debug
false
Enabling this flag will log out the current request.
 
Due Date
string
/ Required
dueDate
Date when the invoice is due. The value is in the YYYY-MM-DD format.
2024-04-10
Invoice Date
string
/ Required
invoiceDate
Date when the invoice is issued to the customer. This value is in the YYYY-MM-DD format.
2024-04-10
Invoice Line Items
code
/ Required
invoiceLineItems
An array of invoice line items.
Invoice Number
string
/ Required
invoiceNumber
User-generated invoice number. This value can be your chosen number scheme or invoice due date.
00e02DTF...

{
  "data": {
    "entity": "Invoice",
    "id": "00e02DTFJUMHHRGKh6zx",
    "isActive": "1",
    "createdBy": "00602ZGNAZQYJBKLdrql",
    "createdTime": "2024-07-31T16:56:53.000+0000",
    "updatedTime": "2024-07-31T20:27:48.000+0000",
    "customerId": "0cu02BLGFCGXROGGsnpx",
    "invoiceNumber": "001",
    "invoiceDate": "2024-07-22",
    "dueDate": "2024-09-08",
    "glPostingDate": "2024-07-22",
    "amount": 2199,
    "localAmount": null,
    "exchangeRate": null,
    "amountDue": 2199,
    "paymentStatus": "1",
    "description": null,
    "poNumber": null,
    "isToBePrinted": false,
    "isToBeEmailed": false,
    "lastSentTime": null,
    "itemSalesTax": "0ii02JKMRQWBGLFLadj8",
    "salesTaxPercentage": 6,
    "salesTaxTotal": 0,
    "terms": "Due upon receipt",
    "salesRep": null,
    "FOB": null,
    "shipDate": null,
    "shipMethod": null,
    "departmentId": "00000000000000000000",
    "locationId": "00000000000000000000",
    "actgClassId": "00000000000000000000",
    "jobId": "00000000000000000000",
    "payToBankAccountId": "00000000000000000000",
    "payToChartOfAccountId": "00000000000000000000",
    "invoiceTemplateId": "itm02EJBDDIGUVGSc8w1",
    "hasAutoPay": false,
    "source": "0",
    "emailDeliveryOption": "1",
    "mailDeliveryOption": "0",
    "creditAmount": 0,
    "quickbooksId": null,
    "recInvoiceTemplateId": "00000000000000000000",
    "financingStatus": "0",
    "netBillId": "00000000000000000000",
    "netOrgId": "00000000000000000000",
    "scheduledAmount": 0,
    "stylingId": null,
    "stylingRevision": null,
    "financingModelStatus": null,
    "financingErrorType": "0",
    "invoiceLineItems": [
      {
        "entity": "InvoiceLineItem",
        "id": "00f02QSSEGYTPEZDeik8",
        "createdTime": "2024-07-31T20:27:48.000+0000",
        "updatedTime": "2024-07-31T20:27:48.000+0000",
        "invoiceId": "00e02DTFJUMHHRGKh6zx",
        "itemId": "0ii02CTRVHZJQMRWad60",
        "quantity": 1,
        "amount": 12,
        "price": 12,
        "serviceDate": null,
        "ratePercent": null,
        "chartOfAccountId": "00000000000000000000",
        "departmentId": "00000000000000000000",
        "locationId": "00000000000000000000",
        "actgClassId": "00000000000000000000",
        "jobId": "00000000000000000000",
        "description": null,
        "taxable": false,
        "taxCode": "Non",
        "lineOrder": 0
      }
    ],
    "invoiceAdjustments": [],
    "invoiceCustomFields": []
  }
}

Create Vendor​

Create a vendor object. | key: createVendor

InputDefaultNotesExample
Additional Fields
code
additionalFields
Additional fields that might not be covered by the standard inputs. See https://developer.bill.com/reference/ap-vendormgmt-createvendor for more information. Go to Prismatic docs to see an example of how to use this input.
Company Name
string
/ Required
companyName
Vendor organization full name.
Example Company
Connection
connection
/ Required
connection
 
 
 
Debug Request
boolean
debug
false
Enabling this flag will log out the current request.
 
Email
string
/ Required
email
Vendor email address.
example@email.com
Vendor Name
string
/ Required
name
Unique vendor name.
Example Vendor

{
  "data": {
    "entity": "Vendor",
    "id": "00902YSABCAKZHY25m0r",
    "isActive": "1",
    "name": "Prismatic Vendor",
    "shortName": null,
    "nameOnCheck": "Prismatic Vendor",
    "companyName": "Prismatic",
    "accNumber": null,
    "taxId": null,
    "taxIdType": null,
    "track1099": false,
    "address1": null,
    "address2": null,
    "address3": null,
    "address4": null,
    "addressCity": null,
    "addressState": null,
    "addressZip": null,
    "addressCountry": null,
    "email": "example@email.com",
    "fax": null,
    "phone": null,
    "payBy": "0",
    "paymentEmail": null,
    "paymentPhone": null,
    "description": null,
    "createdTime": "2024-07-30T19:31:00.000+0000",
    "updatedTime": "2024-07-30T19:31:00.000+0000",
    "contactFirstName": null,
    "contactLastName": null,
    "mergedIntoId": "00000000000000000000",
    "accountType": "0",
    "paymentTermId": "00000000000000000000",
    "sendNotifications": true,
    "balance": 0,
    "availCredit": 0,
    "lastBalanceUpdate": null,
    "externalBillPayIn12m": null,
    "since": null,
    "payDaysBefore": null,
    "enabledCombinePayments": true,
    "hasBankAccountAutoPay": false,
    "hasRecurringPayments": false,
    "billCurrency": "USD",
    "billSyncPref": "0",
    "paymentCurrency": null,
    "prefPmtMethod": "1",
    "paymentPurpose": null,
    "bankCountry": null,
    "vendorBankAccountStatus": -1,
    "sendInviteForPrivateVendor": true,
    "vendorVCardRemitEmail": null,
    "vendorVCardStatus": "-1",
    "orgVCardStatus": "1",
    "prefRemitEmail": "0",
    "remitEmail": null,
    "processorVCardStatus": null,
    "vStatusUpdateSource": null,
    "allowConnectedVendorEditAddress": false,
    "informConnectedVendorAddressSyncModified": false,
    "intlPaymentType": "0",
    "vcardEnrollDate": null,
    "vcardDeclineDate": null,
    "isAccountNumberRequired": false,
    "largeBillerId": "00000000000000000000",
    "orgVCardOptOutCustReason": null,
    "enableFundedInvite": false,
    "lastPaymentDate": null,
    "numberOfInvitesSent": 0,
    "eligibleForEbills": false,
    "acknowledgedEbillBanner": false,
    "acknowledgedEbillError": false,
    "eBillEnablementFailed": false,
    "PaymentusMerchantId": null,
    "unmodifiedBillsCount": 0,
    "setupAutoPayPrompt": false,
    "autoPayConflict": false,
    "nameOnCheckRemediation": false,
    "autoSave": null,
    "autoSaveStatus": null,
    "creationSource": "0",
    "PaymentusPmtType": null,
    "PaymentusAcctToken": null,
    "PaymentusAcctToken2": null,
    "PaymentusAcctToken3": null,
    "stpProcessor": "0",
    "eBillEnabledStatus": "0",
    "orgVCardOptOutCustOther": null,
    "networkStatus": null,
    "vcardProcessor": "1",
    "isAddressValidated": false,
    "isSyncVendorCountryMapped": false,
    "optedOutOfVCardByOrg": false,
    "invalidCountryCurrencyAtNewVendorSync": false,
    "acctBalance": 0,
    "lastAcctBalanceUpdate": null,
    "paymentEmails": null,
    "eBillEligible": false,
    "required": []
  }
}

Create Vendor Bank Account​

Create a vendor bank account object. | key: createVendorBankAccount

InputDefaultNotesExample
Account Number
string
/ Required
accountNumber
Vendor bank account number.
0112345678
Additional Fields
code
additionalFields
Additional fields that might not be covered by the standard inputs. See https://developer.bill.com/reference/ap-vendormgmt-createvendorbankaccount for more information. Go to Prismatic docs to see an example of how to use this input.
Connection
connection
/ Required
connection
 
 
 
Debug Request
boolean
debug
false
Enabling this flag will log out the current request.
 
Device ID
string
/ Required
deviceId
ID of the device. Retrieved from the 'Authenticate MFA session' action.
Prismatic-...
MFA ID
string
/ Required
mfaId
ID of the MFA. Retrieved from the 'Authenticate MFA session' action.
!b_EJCd_jPIsZYT...
Routing Number
string
/ Required
routingNumber
Vendor bank routing number.
012345678
Vendor ID
string
/ Required
vendorId
ID of the vendor.
009...

{
  "data": {
    "entity": "VendorBankAccount",
    "id": "vba02JBPYKSEAMI17lre",
    "isActive": "1",
    "createdTime": "2024-07-31T23:32:48.000+0000",
    "updatedTime": "2024-07-31T23:32:49.000+0000",
    "vendorId": "00902GLBJSUATNY25m0s",
    "nameOnAcct": null,
    "accountNumber": "******7890",
    "routingNumber": "021000021",
    "usersId": "00602ZGNAZQYJBKLdrql",
    "status": "1",
    "isSavings": false,
    "isPersonalAcct": false,
    "intlEPaymentAcct": false,
    "intlPaymentType": "0",
    "paymentCurrency": null,
    "bankCountry": null,
    "vendorBankData": null,
    "bankAddSource": "1",
    "intlTemplateKey": null,
    "regulatory1": null,
    "regulatory2": null,
    "regulatory3": null,
    "regulatory4": null,
    "regulatory5": null,
    "regulatory6": null,
    "regulatory7": null
  }
}

Delete Bill​

Delete a bill object. | key: deleteBill

InputDefaultNotesExample
Bill ID
string
/ Required
billId
Bill ID.
00n...
Connection
connection
/ Required
connection
 
 
 
Debug Request
boolean
debug
false
Enabling this flag will log out the current request.
 

{
  "data": {
    "entity": "Bill",
    "id": "00n02XNWHOPPXWV9ewx0",
    "isActive": "1",
    "vendorId": "00902YSHZXAKZHY25m0r",
    "invoiceNumber": "01",
    "approvalStatus": "0",
    "invoiceDate": "2024-07-01",
    "dueDate": "2024-08-01",
    "glPostingDate": "2024-07-01",
    "amount": 1,
    "localAmount": null,
    "exchangeRate": null,
    "scheduledAmount": 0,
    "paidAmount": null,
    "dueAmount": 1,
    "creditAmount": 0,
    "paymentStatus": "1",
    "uiPaymentStatus": "1",
    "description": null,
    "poNumber": null,
    "createdTime": "2024-07-30T23:00:32.000+0000",
    "updatedTime": "2024-07-30T23:00:32.000+0000",
    "createdBy": "00602ZGNAZQYJBKLdrql",
    "payFromBankAccountId": "00000000000000000000",
    "payFromChartOfAccountId": "00000000000000000000",
    "paymentTermId": "00000000000000000000",
    "hasAutoPay": false,
    "eBillCreated": false,
    "invoiceProductId": "00000000000000000000",
    "chartOfAccountId": "00000000000000000000",
    "departmentId": "00000000000000000000",
    "locationId": "00000000000000000000",
    "actgClassId": "00000000000000000000",
    "source": "0",
    "numApprPolicyEx": 0,
    "useBillDesc": false,
    "defaultInvoiceNumber": false,
    "isAutoSaved": false,
    "billTemplateId": "00000000000000000000",
    "quickbooksId": null,
    "lastPaymentDate": null,
    "fullPaymentDate": null,
    "hasLinkedPurchaseOrders": false,
    "multipleBillLineItems": false,
    "item": {
      "count": 0,
      "totalAmount": 0
    },
    "expense": {
      "count": 1,
      "totalAmount": 1,
      "chartOfAccountGroup": []
    },
    "billLineItems": [
      {
        "entity": "BillLineItem",
        "id": "bli02VSXIUDVFUQd1e4s",
        "billId": "00n02XNWHOPPXWV9ewx0",
        "amount": 1,
        "chartOfAccountId": "00000000000000000000",
        "departmentId": "00000000000000000000",
        "locationId": "00000000000000000000",
        "jobId": "00000000000000000000",
        "customerId": "00000000000000000000",
        "jobBillable": false,
        "description": null,
        "createdTime": "2024-07-30T23:00:32.000+0000",
        "updatedTime": "2024-07-30T23:00:32.000+0000",
        "lineType": "1",
        "itemId": "00000000000000000000",
        "quantity": null,
        "unitPrice": null,
        "employeeId": "00000000000000000000",
        "actgClassId": "00000000000000000000",
        "purchaseOrderBillLinkId": "00000000000000000000",
        "unitOfMeasureId": "00000000000000000000",
        "lineOrder": 0
      }
    ]
  }
}

Delete Customer​

Delete a customer object. | key: deleteCustomer

InputDefaultNotesExample
Connection
connection
/ Required
connection
 
 
 
Customer ID
string
/ Required
customerId
ID of the customer.
0cu...
Debug Request
boolean
debug
false
Enabling this flag will log out the current request.
 

{
  "data": {
    "entity": "Customer",
    "id": "0cu02EAQUAPCBNTDsmzc",
    "isActive": "1",
    "createdTime": "2024-07-29T20:30:30.000+0000",
    "updatedTime": "2024-07-30T19:14:48.000+0000",
    "name": "John",
    "shortName": null,
    "parentCustomerId": "00000000000000000000",
    "companyName": "A Company",
    "contactFirstName": "John",
    "contactLastName": "Doe",
    "accNumber": null,
    "billAddress1": null,
    "billAddress2": null,
    "billAddress3": null,
    "billAddress4": null,
    "billAddressCity": null,
    "billAddressState": null,
    "billAddressCountry": null,
    "billAddressZip": null,
    "shipAddress1": null,
    "shipAddress2": null,
    "shipAddress3": null,
    "shipAddress4": null,
    "shipAddressCity": null,
    "shipAddressState": null,
    "shipAddressCountry": null,
    "shipAddressZip": null,
    "email": null,
    "phone": null,
    "altPhone": null,
    "fax": null,
    "description": null,
    "invoiceCurrency": null,
    "printAs": null,
    "mergedIntoId": "00000000000000000000",
    "hasAuthorizedToCharge": false,
    "accountType": "0",
    "paymentTermId": "00000000000000000000",
    "balance": 0,
    "availCredit": 0,
    "taxId": null,
    "hasBankAccount": false,
    "hasNetBankAccount": false,
    "hasBankAccountAutoPay": false,
    "hasCreditCard": false,
    "hasCreditCardAutoPay": false,
    "defaultDeliveryMethod": null,
    "isAutoChargeDismissed": false,
    "isTaxLiable": false,
    "creationSource": "0",
    "enabledInvoiceFinancing": false,
    "hasCustomerCard": false,
    "enabledAutoInvoiceFinancing": false
  }
}

Delete Invoice​

Delete an invoice object. | key: deleteInvoice

InputDefaultNotesExample
Connection
connection
/ Required
connection
 
 
 
Debug Request
boolean
debug
false
Enabling this flag will log out the current request.
 
Invoice ID
string
/ Required
invoiceId
The ID of the invoice.
00e...

{
  "data": {
    "entity": "Invoice",
    "id": "00e02DTFJUMHHRGKh6zx",
    "isActive": "1",
    "createdBy": "00602ZGNAZQYJBKLdrql",
    "createdTime": "2024-07-31T16:56:53.000+0000",
    "updatedTime": "2024-07-31T20:27:48.000+0000",
    "customerId": "0cu02BLGFCGXROGGsnpx",
    "invoiceNumber": "001",
    "invoiceDate": "2024-07-22",
    "dueDate": "2024-09-08",
    "glPostingDate": "2024-07-22",
    "amount": 2199,
    "localAmount": null,
    "exchangeRate": null,
    "amountDue": 2199,
    "paymentStatus": "1",
    "description": null,
    "poNumber": null,
    "isToBePrinted": false,
    "isToBeEmailed": false,
    "lastSentTime": null,
    "itemSalesTax": "0ii02JKMRQWBGLFLadj8",
    "salesTaxPercentage": 6,
    "salesTaxTotal": 0,
    "terms": "Due upon receipt",
    "salesRep": null,
    "FOB": null,
    "shipDate": null,
    "shipMethod": null,
    "departmentId": "00000000000000000000",
    "locationId": "00000000000000000000",
    "actgClassId": "00000000000000000000",
    "jobId": "00000000000000000000",
    "payToBankAccountId": "00000000000000000000",
    "payToChartOfAccountId": "00000000000000000000",
    "invoiceTemplateId": "itm02EJBDDIGUVGSc8w1",
    "hasAutoPay": false,
    "source": "0",
    "emailDeliveryOption": "1",
    "mailDeliveryOption": "0",
    "creditAmount": 0,
    "quickbooksId": null,
    "recInvoiceTemplateId": "00000000000000000000",
    "financingStatus": "0",
    "netBillId": "00000000000000000000",
    "netOrgId": "00000000000000000000",
    "scheduledAmount": 0,
    "stylingId": null,
    "stylingRevision": null,
    "financingModelStatus": null,
    "financingErrorType": "0",
    "invoiceLineItems": [
      {
        "entity": "InvoiceLineItem",
        "id": "00f02QSSEGYTPEZDeik8",
        "createdTime": "2024-07-31T20:27:48.000+0000",
        "updatedTime": "2024-07-31T20:27:48.000+0000",
        "invoiceId": "00e02DTFJUMHHRGKh6zx",
        "itemId": "0ii02CTRVHZJQMRWad60",
        "quantity": 1,
        "amount": 12,
        "price": 12,
        "serviceDate": null,
        "ratePercent": null,
        "chartOfAccountId": "00000000000000000000",
        "departmentId": "00000000000000000000",
        "locationId": "00000000000000000000",
        "actgClassId": "00000000000000000000",
        "jobId": "00000000000000000000",
        "description": null,
        "taxable": false,
        "taxCode": "Non",
        "lineOrder": 0
      }
    ],
    "invoiceAdjustments": [],
    "invoiceCustomFields": []
  }
}

Delete Vendor​

Delete a vendor object. | key: deleteVendor

InputDefaultNotesExample
Connection
connection
/ Required
connection
 
 
 
Debug Request
boolean
debug
false
Enabling this flag will log out the current request.
 
Vendor ID
string
/ Required
vendorId
ID of the vendor.
009...

{
  "data": {
    "entity": "Vendor",
    "id": "00902YSABCAKZHY25m0r",
    "isActive": "1",
    "name": "Prismatic Vendor",
    "shortName": null,
    "nameOnCheck": "Prismatic Vendor",
    "companyName": "Prismatic",
    "accNumber": null,
    "taxId": null,
    "taxIdType": null,
    "track1099": false,
    "address1": null,
    "address2": null,
    "address3": null,
    "address4": null,
    "addressCity": null,
    "addressState": null,
    "addressZip": null,
    "addressCountry": null,
    "email": "example@email.com",
    "fax": null,
    "phone": null,
    "payBy": "0",
    "paymentEmail": null,
    "paymentPhone": null,
    "description": null,
    "createdTime": "2024-07-30T19:31:00.000+0000",
    "updatedTime": "2024-07-30T19:31:00.000+0000",
    "contactFirstName": null,
    "contactLastName": null,
    "mergedIntoId": "00000000000000000000",
    "accountType": "0",
    "paymentTermId": "00000000000000000000",
    "sendNotifications": true,
    "balance": 0,
    "availCredit": 0,
    "lastBalanceUpdate": null,
    "externalBillPayIn12m": null,
    "since": null,
    "payDaysBefore": null,
    "enabledCombinePayments": true,
    "hasBankAccountAutoPay": false,
    "hasRecurringPayments": false,
    "billCurrency": "USD",
    "billSyncPref": "0",
    "paymentCurrency": null,
    "prefPmtMethod": "1",
    "paymentPurpose": null,
    "bankCountry": null,
    "vendorBankAccountStatus": -1,
    "sendInviteForPrivateVendor": true,
    "vendorVCardRemitEmail": null,
    "vendorVCardStatus": "-1",
    "orgVCardStatus": "1",
    "prefRemitEmail": "0",
    "remitEmail": null,
    "processorVCardStatus": null,
    "vStatusUpdateSource": null,
    "allowConnectedVendorEditAddress": false,
    "informConnectedVendorAddressSyncModified": false,
    "intlPaymentType": "0",
    "vcardEnrollDate": null,
    "vcardDeclineDate": null,
    "isAccountNumberRequired": false,
    "largeBillerId": "00000000000000000000",
    "orgVCardOptOutCustReason": null,
    "enableFundedInvite": false,
    "lastPaymentDate": null,
    "numberOfInvitesSent": 0,
    "eligibleForEbills": false,
    "acknowledgedEbillBanner": false,
    "acknowledgedEbillError": false,
    "eBillEnablementFailed": false,
    "PaymentusMerchantId": null,
    "unmodifiedBillsCount": 0,
    "setupAutoPayPrompt": false,
    "autoPayConflict": false,
    "nameOnCheckRemediation": false,
    "autoSave": null,
    "autoSaveStatus": null,
    "creationSource": "0",
    "PaymentusPmtType": null,
    "PaymentusAcctToken": null,
    "PaymentusAcctToken2": null,
    "PaymentusAcctToken3": null,
    "stpProcessor": "0",
    "eBillEnabledStatus": "0",
    "orgVCardOptOutCustOther": null,
    "networkStatus": null,
    "vcardProcessor": "1",
    "isAddressValidated": false,
    "isSyncVendorCountryMapped": false,
    "optedOutOfVCardByOrg": false,
    "invalidCountryCurrencyAtNewVendorSync": false,
    "acctBalance": 0,
    "lastAcctBalanceUpdate": null,
    "paymentEmails": null,
    "eBillEligible": false,
    "required": []
  }
}

Delete Vendor Bank Account​

Delete a vendor bank account object. | key: deleteVendorBankAccount

InputDefaultNotesExample
Connection
connection
/ Required
connection
 
 
 
Debug Request
boolean
debug
false
Enabling this flag will log out the current request.
 
Device ID
string
/ Required
deviceId
ID of the device. Retrieved from the 'Authenticate MFA session' action.
Prismatic-...
MFA ID
string
/ Required
mfaId
ID of the MFA. Retrieved from the 'Authenticate MFA session' action.
!b_EJCd_jPIsZYT...
Vendor Bank Account ID
string
/ Required
vendorBankAccountId
ID of the vendor bank account.
vba...

{
  "data": {
    "entity": "VendorBankAccount",
    "id": "vba02JBPYKSEAMI17lre",
    "isActive": "1",
    "createdTime": "2024-07-31T23:32:48.000+0000",
    "updatedTime": "2024-07-31T23:32:49.000+0000",
    "vendorId": "00902GLBJSUATNY25m0s",
    "nameOnAcct": null,
    "accountNumber": "******7890",
    "routingNumber": "021000021",
    "usersId": "00602ZGNAZQYJBKLdrql",
    "status": "1",
    "isSavings": false,
    "isPersonalAcct": false,
    "intlEPaymentAcct": false,
    "intlPaymentType": "0",
    "paymentCurrency": null,
    "bankCountry": null,
    "vendorBankData": null,
    "bankAddSource": "1",
    "intlTemplateKey": null,
    "regulatory1": null,
    "regulatory2": null,
    "regulatory3": null,
    "regulatory4": null,
    "regulatory5": null,
    "regulatory6": null,
    "regulatory7": null
  }
}

Generate an MFA challenge ID​

Use this action to create a trusted MFA session. | key: generateMfaChallengeId

InputDefaultNotes
Connection
connection
/ Required
connection
 
 
Debug Request
boolean
debug
false
Enabling this flag will log out the current request.
Use backup
boolean
useBackup
false
Turn this On to use the backup mobile device for MFA.

{
  "data": {
    "challengeId": "!b-KXe8pBDp1vFgjczl...",
    "sessionId": "!b2XqzA2v6u5T49jY5..."
  }
}

Get Bill​

Read a bill object. | key: getBill

InputDefaultNotesExample
Bill ID
string
/ Required
billId
Bill ID.
00n...
Connection
connection
/ Required
connection
 
 
 
Debug Request
boolean
debug
false
Enabling this flag will log out the current request.
 

{
  "data": {
    "entity": "Bill",
    "id": "00n02XNWHOPPXWV9ewx0",
    "isActive": "1",
    "vendorId": "00902YSHZXAKZHY25m0r",
    "invoiceNumber": "01",
    "approvalStatus": "0",
    "invoiceDate": "2024-07-01",
    "dueDate": "2024-08-01",
    "glPostingDate": "2024-07-01",
    "amount": 1,
    "localAmount": null,
    "exchangeRate": null,
    "scheduledAmount": 0,
    "paidAmount": null,
    "dueAmount": 1,
    "creditAmount": 0,
    "paymentStatus": "1",
    "uiPaymentStatus": "1",
    "description": null,
    "poNumber": null,
    "createdTime": "2024-07-30T23:00:32.000+0000",
    "updatedTime": "2024-07-30T23:00:32.000+0000",
    "createdBy": "00602ZGNAZQYJBKLdrql",
    "payFromBankAccountId": "00000000000000000000",
    "payFromChartOfAccountId": "00000000000000000000",
    "paymentTermId": "00000000000000000000",
    "hasAutoPay": false,
    "eBillCreated": false,
    "invoiceProductId": "00000000000000000000",
    "chartOfAccountId": "00000000000000000000",
    "departmentId": "00000000000000000000",
    "locationId": "00000000000000000000",
    "actgClassId": "00000000000000000000",
    "source": "0",
    "numApprPolicyEx": 0,
    "useBillDesc": false,
    "defaultInvoiceNumber": false,
    "isAutoSaved": false,
    "billTemplateId": "00000000000000000000",
    "quickbooksId": null,
    "lastPaymentDate": null,
    "fullPaymentDate": null,
    "hasLinkedPurchaseOrders": false,
    "multipleBillLineItems": false,
    "item": {
      "count": 0,
      "totalAmount": 0
    },
    "expense": {
      "count": 1,
      "totalAmount": 1,
      "chartOfAccountGroup": []
    },
    "billLineItems": [
      {
        "entity": "BillLineItem",
        "id": "bli02VSXIUDVFUQd1e4s",
        "billId": "00n02XNWHOPPXWV9ewx0",
        "amount": 1,
        "chartOfAccountId": "00000000000000000000",
        "departmentId": "00000000000000000000",
        "locationId": "00000000000000000000",
        "jobId": "00000000000000000000",
        "customerId": "00000000000000000000",
        "jobBillable": false,
        "description": null,
        "createdTime": "2024-07-30T23:00:32.000+0000",
        "updatedTime": "2024-07-30T23:00:32.000+0000",
        "lineType": "1",
        "itemId": "00000000000000000000",
        "quantity": null,
        "unitPrice": null,
        "employeeId": "00000000000000000000",
        "actgClassId": "00000000000000000000",
        "purchaseOrderBillLinkId": "00000000000000000000",
        "unitOfMeasureId": "00000000000000000000",
        "lineOrder": 0
      }
    ]
  }
}

Get Customer​

Read a customer object. | key: getCustomer

InputDefaultNotesExample
Connection
connection
/ Required
connection
 
 
 
Customer ID
string
/ Required
customerId
ID of the customer.
0cu...
Debug Request
boolean
debug
false
Enabling this flag will log out the current request.
 

{
  "data": {
    "entity": "Customer",
    "id": "0cu02EAQUAPCBNTDsmzc",
    "isActive": "1",
    "createdTime": "2024-07-29T20:30:30.000+0000",
    "updatedTime": "2024-07-30T19:14:48.000+0000",
    "name": "John",
    "shortName": null,
    "parentCustomerId": "00000000000000000000",
    "companyName": "A Company",
    "contactFirstName": "John",
    "contactLastName": "Doe",
    "accNumber": null,
    "billAddress1": null,
    "billAddress2": null,
    "billAddress3": null,
    "billAddress4": null,
    "billAddressCity": null,
    "billAddressState": null,
    "billAddressCountry": null,
    "billAddressZip": null,
    "shipAddress1": null,
    "shipAddress2": null,
    "shipAddress3": null,
    "shipAddress4": null,
    "shipAddressCity": null,
    "shipAddressState": null,
    "shipAddressCountry": null,
    "shipAddressZip": null,
    "email": null,
    "phone": null,
    "altPhone": null,
    "fax": null,
    "description": null,
    "invoiceCurrency": null,
    "printAs": null,
    "mergedIntoId": "00000000000000000000",
    "hasAuthorizedToCharge": false,
    "accountType": "0",
    "paymentTermId": "00000000000000000000",
    "balance": 0,
    "availCredit": 0,
    "taxId": null,
    "hasBankAccount": false,
    "hasNetBankAccount": false,
    "hasBankAccountAutoPay": false,
    "hasCreditCard": false,
    "hasCreditCardAutoPay": false,
    "defaultDeliveryMethod": null,
    "isAutoChargeDismissed": false,
    "isTaxLiable": false,
    "creationSource": "0",
    "enabledInvoiceFinancing": false,
    "hasCustomerCard": false,
    "enabledAutoInvoiceFinancing": false
  }
}

Get Customer Bank Account​

Read a customer bank account object. | key: getCustomerBankAccount

InputDefaultNotesExample
Connection
connection
/ Required
connection
 
 
 
Customer Bank Account ID
string
/ Required
customerBankAccountId
ID of the customer bank account.
cba...
Debug Request
boolean
debug
false
Enabling this flag will log out the current request.
 

{
  "data": {
    "entity": "CustomerBankAccount",
    "id": "cba02ILJVKOLFVLB6gqr",
    "isActive": "1",
    "createdTime": "2024-07-31T05:10:12.000+0000",
    "updatedTime": "2024-07-31T05:17:36.000+0000",
    "customerId": "0cu02BLGFCGXROGGsnpx",
    "nameOnAccount": "Test",
    "nickname": "Test",
    "routingNumber": "011401533",
    "accountNumber": "******7890",
    "isLockedByOrg": false,
    "isSavings": false,
    "isPersonalAcct": false,
    "isWrittenAuth": false,
    "isPrivate": false,
    "phone": null,
    "cpUserId": "00000000000000000000",
    "status": "1",
    "rndDepExpireDate": "2024-08-13"
  }
}

Get Invoice​

Read an invoice object. | key: getInvoice

InputDefaultNotesExample
Connection
connection
/ Required
connection
 
 
 
Debug Request
boolean
debug
false
Enabling this flag will log out the current request.
 
Invoice ID
string
/ Required
invoiceId
The ID of the invoice.
00e...

{
  "data": {
    "entity": "Invoice",
    "id": "00e02DTFJUMHHRGKh6zx",
    "isActive": "1",
    "createdBy": "00602ZGNAZQYJBKLdrql",
    "createdTime": "2024-07-31T16:56:53.000+0000",
    "updatedTime": "2024-07-31T20:27:48.000+0000",
    "customerId": "0cu02BLGFCGXROGGsnpx",
    "invoiceNumber": "001",
    "invoiceDate": "2024-07-22",
    "dueDate": "2024-09-08",
    "glPostingDate": "2024-07-22",
    "amount": 2199,
    "localAmount": null,
    "exchangeRate": null,
    "amountDue": 2199,
    "paymentStatus": "1",
    "description": null,
    "poNumber": null,
    "isToBePrinted": false,
    "isToBeEmailed": false,
    "lastSentTime": null,
    "itemSalesTax": "0ii02JKMRQWBGLFLadj8",
    "salesTaxPercentage": 6,
    "salesTaxTotal": 0,
    "terms": "Due upon receipt",
    "salesRep": null,
    "FOB": null,
    "shipDate": null,
    "shipMethod": null,
    "departmentId": "00000000000000000000",
    "locationId": "00000000000000000000",
    "actgClassId": "00000000000000000000",
    "jobId": "00000000000000000000",
    "payToBankAccountId": "00000000000000000000",
    "payToChartOfAccountId": "00000000000000000000",
    "invoiceTemplateId": "itm02EJBDDIGUVGSc8w1",
    "hasAutoPay": false,
    "source": "0",
    "emailDeliveryOption": "1",
    "mailDeliveryOption": "0",
    "creditAmount": 0,
    "quickbooksId": null,
    "recInvoiceTemplateId": "00000000000000000000",
    "financingStatus": "0",
    "netBillId": "00000000000000000000",
    "netOrgId": "00000000000000000000",
    "scheduledAmount": 0,
    "stylingId": null,
    "stylingRevision": null,
    "financingModelStatus": null,
    "financingErrorType": "0",
    "invoiceLineItems": [
      {
        "entity": "InvoiceLineItem",
        "id": "00f02QSSEGYTPEZDeik8",
        "createdTime": "2024-07-31T20:27:48.000+0000",
        "updatedTime": "2024-07-31T20:27:48.000+0000",
        "invoiceId": "00e02DTFJUMHHRGKh6zx",
        "itemId": "0ii02CTRVHZJQMRWad60",
        "quantity": 1,
        "amount": 12,
        "price": 12,
        "serviceDate": null,
        "ratePercent": null,
        "chartOfAccountId": "00000000000000000000",
        "departmentId": "00000000000000000000",
        "locationId": "00000000000000000000",
        "actgClassId": "00000000000000000000",
        "jobId": "00000000000000000000",
        "description": null,
        "taxable": false,
        "taxCode": "Non",
        "lineOrder": 0
      }
    ],
    "invoiceAdjustments": [],
    "invoiceCustomFields": []
  }
}

Get Vendor​

Read a vendor object. | key: getVendor

InputDefaultNotesExample
Connection
connection
/ Required
connection
 
 
 
Debug Request
boolean
debug
false
Enabling this flag will log out the current request.
 
Vendor ID
string
/ Required
vendorId
ID of the vendor.
009...

{
  "data": {
    "entity": "Vendor",
    "id": "00902YSABCAKZHY25m0r",
    "isActive": "1",
    "name": "Prismatic Vendor",
    "shortName": null,
    "nameOnCheck": "Prismatic Vendor",
    "companyName": "Prismatic",
    "accNumber": null,
    "taxId": null,
    "taxIdType": null,
    "track1099": false,
    "address1": null,
    "address2": null,
    "address3": null,
    "address4": null,
    "addressCity": null,
    "addressState": null,
    "addressZip": null,
    "addressCountry": null,
    "email": "example@email.com",
    "fax": null,
    "phone": null,
    "payBy": "0",
    "paymentEmail": null,
    "paymentPhone": null,
    "description": null,
    "createdTime": "2024-07-30T19:31:00.000+0000",
    "updatedTime": "2024-07-30T19:31:00.000+0000",
    "contactFirstName": null,
    "contactLastName": null,
    "mergedIntoId": "00000000000000000000",
    "accountType": "0",
    "paymentTermId": "00000000000000000000",
    "sendNotifications": true,
    "balance": 0,
    "availCredit": 0,
    "lastBalanceUpdate": null,
    "externalBillPayIn12m": null,
    "since": null,
    "payDaysBefore": null,
    "enabledCombinePayments": true,
    "hasBankAccountAutoPay": false,
    "hasRecurringPayments": false,
    "billCurrency": "USD",
    "billSyncPref": "0",
    "paymentCurrency": null,
    "prefPmtMethod": "1",
    "paymentPurpose": null,
    "bankCountry": null,
    "vendorBankAccountStatus": -1,
    "sendInviteForPrivateVendor": true,
    "vendorVCardRemitEmail": null,
    "vendorVCardStatus": "-1",
    "orgVCardStatus": "1",
    "prefRemitEmail": "0",
    "remitEmail": null,
    "processorVCardStatus": null,
    "vStatusUpdateSource": null,
    "allowConnectedVendorEditAddress": false,
    "informConnectedVendorAddressSyncModified": false,
    "intlPaymentType": "0",
    "vcardEnrollDate": null,
    "vcardDeclineDate": null,
    "isAccountNumberRequired": false,
    "largeBillerId": "00000000000000000000",
    "orgVCardOptOutCustReason": null,
    "enableFundedInvite": false,
    "lastPaymentDate": null,
    "numberOfInvitesSent": 0,
    "eligibleForEbills": false,
    "acknowledgedEbillBanner": false,
    "acknowledgedEbillError": false,
    "eBillEnablementFailed": false,
    "PaymentusMerchantId": null,
    "unmodifiedBillsCount": 0,
    "setupAutoPayPrompt": false,
    "autoPayConflict": false,
    "nameOnCheckRemediation": false,
    "autoSave": null,
    "autoSaveStatus": null,
    "creationSource": "0",
    "PaymentusPmtType": null,
    "PaymentusAcctToken": null,
    "PaymentusAcctToken2": null,
    "PaymentusAcctToken3": null,
    "stpProcessor": "0",
    "eBillEnabledStatus": "0",
    "orgVCardOptOutCustOther": null,
    "networkStatus": null,
    "vcardProcessor": "1",
    "isAddressValidated": false,
    "isSyncVendorCountryMapped": false,
    "optedOutOfVCardByOrg": false,
    "invalidCountryCurrencyAtNewVendorSync": false,
    "acctBalance": 0,
    "lastAcctBalanceUpdate": null,
    "paymentEmails": null,
    "eBillEligible": false,
    "required": []
  }
}

Get Vendor Bank Account​

Read a vendor bank account object. | key: getVendorBankAccount

InputDefaultNotesExample
Connection
connection
/ Required
connection
 
 
 
Debug Request
boolean
debug
false
Enabling this flag will log out the current request.
 
Vendor Bank Account ID
string
/ Required
vendorBankAccountId
ID of the vendor bank account.
vba...

{
  "data": {
    "entity": "VendorBankAccount",
    "id": "vba02BSNHVJVZPN17kxr",
    "isActive": "1",
    "createdTime": "2024-07-30T20:33:28.000+0000",
    "updatedTime": "2024-07-30T20:33:28.000+0000",
    "vendorId": "00902JIJYMCGEGI25m2l",
    "nameOnAcct": "John Doe",
    "accountNumber": "******7890",
    "routingNumber": "021000021",
    "usersId": "00602ZGNAZQYJBKLdrql",
    "status": "1",
    "isSavings": false,
    "isPersonalAcct": false,
    "intlEPaymentAcct": false,
    "intlPaymentType": "0",
    "paymentCurrency": null,
    "bankCountry": null,
    "vendorBankData": null,
    "bankAddSource": "2",
    "intlTemplateKey": null,
    "regulatory1": null,
    "regulatory2": null,
    "regulatory3": null,
    "regulatory4": null,
    "regulatory5": null,
    "regulatory6": null,
    "regulatory7": null
  }
}

List Bills​

List bill objects. | key: listBills

InputDefaultNotesExample
Connection
connection
/ Required
connection
 
 
 
Debug Request
boolean
debug
false
Enabling this flag will log out the current request.
 
Filters
code
filters
An array of filters to apply. See https://developer.bill.com/reference/ap-vendortransactions-listbill for more information. Go to Prismatic docs to see an example of how to use this input.
Max
string
/ Required
max
999
Maximum number of results to return.
999
Nested
boolean
nested
false
Set as true to include additional nested data in the response.
 
Sort
code
sort
An array of sort objects. See https://developer.bill.com/reference/ap-vendortransactions-listbill for more information. Go to Prismatic docs to see an example of how to use this input.
Start
string
/ Required
start
0
Index of the first result.
0

{
  "data": [
    {
      "entity": "Bill",
      "id": "00n02XNWHOPPXWV9ewx0",
      "isActive": "1",
      "vendorId": "00902YSHZXAKZHY25m0r",
      "invoiceNumber": "01",
      "approvalStatus": "0",
      "invoiceDate": "2024-07-01",
      "dueDate": "2024-08-01",
      "glPostingDate": "2024-07-01",
      "amount": 1,
      "localAmount": null,
      "exchangeRate": null,
      "scheduledAmount": 0,
      "paidAmount": null,
      "dueAmount": 1,
      "creditAmount": 0,
      "paymentStatus": "1",
      "uiPaymentStatus": "1",
      "description": null,
      "poNumber": null,
      "createdTime": "2024-07-30T23:00:32.000+0000",
      "updatedTime": "2024-07-30T23:00:32.000+0000",
      "createdBy": "00602ZGNAZQYJBKLdrql",
      "payFromBankAccountId": "00000000000000000000",
      "payFromChartOfAccountId": "00000000000000000000",
      "paymentTermId": "00000000000000000000",
      "hasAutoPay": false,
      "eBillCreated": false,
      "invoiceProductId": "00000000000000000000",
      "chartOfAccountId": "00000000000000000000",
      "departmentId": "00000000000000000000",
      "locationId": "00000000000000000000",
      "actgClassId": "00000000000000000000",
      "source": "0",
      "numApprPolicyEx": 0,
      "useBillDesc": false,
      "defaultInvoiceNumber": false,
      "isAutoSaved": false,
      "billTemplateId": "00000000000000000000",
      "quickbooksId": null,
      "lastPaymentDate": null,
      "fullPaymentDate": null,
      "hasLinkedPurchaseOrders": false,
      "multipleBillLineItems": false,
      "item": {
        "count": 0,
        "totalAmount": 0
      },
      "expense": {
        "count": 1,
        "totalAmount": 1,
        "chartOfAccountGroup": []
      },
      "billLineItems": [
        {
          "entity": "BillLineItem",
          "id": "bli02VSXIUDVFUQd1e4s",
          "billId": "00n02XNWHOPPXWV9ewx0",
          "amount": 1,
          "chartOfAccountId": "00000000000000000000",
          "departmentId": "00000000000000000000",
          "locationId": "00000000000000000000",
          "jobId": "00000000000000000000",
          "customerId": "00000000000000000000",
          "jobBillable": false,
          "description": null,
          "createdTime": "2024-07-30T23:00:32.000+0000",
          "updatedTime": "2024-07-30T23:00:32.000+0000",
          "lineType": "1",
          "itemId": "00000000000000000000",
          "quantity": null,
          "unitPrice": null,
          "employeeId": "00000000000000000000",
          "actgClassId": "00000000000000000000",
          "purchaseOrderBillLinkId": "00000000000000000000",
          "unitOfMeasureId": "00000000000000000000",
          "lineOrder": 0
        }
      ]
    }
  ]
}

List Customer​

List customer objects. | key: listCustomer

InputDefaultNotesExample
Connection
connection
/ Required
connection
 
 
 
Debug Request
boolean
debug
false
Enabling this flag will log out the current request.
 
Filters
code
filters
An array of filters to apply. See https://developer.bill.com/reference/ar-customermgmt-listcustomer for more information. Go to Prismatic docs to see an example of how to use this input.
Max
string
/ Required
max
999
Maximum number of results to return.
999
Nested
boolean
nested
false
Set as true to include additional nested data in the response.
 
Sort
code
sort
An array of sort objects. See https://developer.bill.com/reference/ar-customermgmt-listcustomer for more information. Go to Prismatic docs to see an example of how to use this input.
Start
string
/ Required
start
0
Index of the first result.
0

{
  "data": [
    {
      "entity": "Customer",
      "id": "0cu02EAQUAPCBNTDsmzc",
      "isActive": "1",
      "createdTime": "2024-07-29T20:30:30.000+0000",
      "updatedTime": "2024-07-30T19:14:48.000+0000",
      "name": "John",
      "shortName": null,
      "parentCustomerId": "00000000000000000000",
      "companyName": "A Company",
      "contactFirstName": "John",
      "contactLastName": "Doe",
      "accNumber": null,
      "billAddress1": null,
      "billAddress2": null,
      "billAddress3": null,
      "billAddress4": null,
      "billAddressCity": null,
      "billAddressState": null,
      "billAddressCountry": null,
      "billAddressZip": null,
      "shipAddress1": null,
      "shipAddress2": null,
      "shipAddress3": null,
      "shipAddress4": null,
      "shipAddressCity": null,
      "shipAddressState": null,
      "shipAddressCountry": null,
      "shipAddressZip": null,
      "email": null,
      "phone": null,
      "altPhone": null,
      "fax": null,
      "description": null,
      "invoiceCurrency": null,
      "printAs": null,
      "mergedIntoId": "00000000000000000000",
      "hasAuthorizedToCharge": false,
      "accountType": "0",
      "paymentTermId": "00000000000000000000",
      "balance": 0,
      "availCredit": 0,
      "taxId": null,
      "hasBankAccount": false,
      "hasNetBankAccount": false,
      "hasBankAccountAutoPay": false,
      "hasCreditCard": false,
      "hasCreditCardAutoPay": false,
      "defaultDeliveryMethod": null,
      "isAutoChargeDismissed": false,
      "isTaxLiable": false,
      "creationSource": "0",
      "enabledInvoiceFinancing": false,
      "hasCustomerCard": false,
      "enabledAutoInvoiceFinancing": false
    }
  ]
}

List Customer Bank Account​

List customer bank account objects. | key: listCustomerBankAccount

InputDefaultNotesExample
Connection
connection
/ Required
connection
 
 
 
Debug Request
boolean
debug
false
Enabling this flag will log out the current request.
 
Filters
code
filters
An array of filters to apply. See https://developer.bill.com/reference/ar-customermgmt-listcustomerbankaccount for more information. Go to Prismatic docs to see an example of how to use this input.
Max
string
/ Required
max
999
Maximum number of results to return.
999
Nested
boolean
nested
false
Set as true to include additional nested data in the response.
 
Sort
code
sort
An array of sort objects. See https://developer.bill.com/reference/ar-customermgmt-listcustomerbankaccount for more information. Go to Prismatic docs to see an example of how to use this input.
Start
string
/ Required
start
0
Index of the first result.
0

{
  "data": [
    {
      "entity": "CustomerBankAccount",
      "id": "cba02ILJVKOLFVLB6gqr",
      "isActive": "1",
      "createdTime": "2024-07-31T05:10:12.000+0000",
      "updatedTime": "2024-07-31T05:17:36.000+0000",
      "customerId": "0cu02BLGFCGXROGGsnpx",
      "nameOnAccount": "Test",
      "nickname": "Test",
      "routingNumber": "011401533",
      "accountNumber": "******7890",
      "isLockedByOrg": false,
      "isSavings": false,
      "isPersonalAcct": false,
      "isWrittenAuth": false,
      "isPrivate": false,
      "phone": null,
      "cpUserId": "00000000000000000000",
      "status": "1",
      "rndDepExpireDate": "2024-08-13"
    }
  ]
}

List Invoices​

List invoice objects. | key: listInvoice

InputDefaultNotesExample
Connection
connection
/ Required
connection
 
 
 
Debug Request
boolean
debug
false
Enabling this flag will log out the current request.
 
Filters
code
filters
An array of filters to apply. See https://developer.bill.com/reference/ar-customertransactions-listinvoice for more information. Go to Prismatic docs to see an example of how to use this input.
Max
string
/ Required
max
999
Maximum number of results to return.
999
Nested
boolean
nested
false
Set as true to include additional nested data in the response.
 
Sort
code
sort
An array of sort objects. See https://developer.bill.com/reference/ar-customertransactions-listinvoice for more information. Go to Prismatic docs to see an example of how to use this input.
Start
string
/ Required
start
0
Index of the first result.
0

{
  "data": [
    {
      "entity": "Invoice",
      "id": "00e02DTFJUMHHRGKh6zx",
      "isActive": "1",
      "createdBy": "00602ZGNAZQYJBKLdrql",
      "createdTime": "2024-07-31T16:56:53.000+0000",
      "updatedTime": "2024-07-31T20:27:48.000+0000",
      "customerId": "0cu02BLGFCGXROGGsnpx",
      "invoiceNumber": "001",
      "invoiceDate": "2024-07-22",
      "dueDate": "2024-09-08",
      "glPostingDate": "2024-07-22",
      "amount": 2199,
      "localAmount": null,
      "exchangeRate": null,
      "amountDue": 2199,
      "paymentStatus": "1",
      "description": null,
      "poNumber": null,
      "isToBePrinted": false,
      "isToBeEmailed": false,
      "lastSentTime": null,
      "itemSalesTax": "0ii02JKMRQWBGLFLadj8",
      "salesTaxPercentage": 6,
      "salesTaxTotal": 0,
      "terms": "Due upon receipt",
      "salesRep": null,
      "FOB": null,
      "shipDate": null,
      "shipMethod": null,
      "departmentId": "00000000000000000000",
      "locationId": "00000000000000000000",
      "actgClassId": "00000000000000000000",
      "jobId": "00000000000000000000",
      "payToBankAccountId": "00000000000000000000",
      "payToChartOfAccountId": "00000000000000000000",
      "invoiceTemplateId": "itm02EJBDDIGUVGSc8w1",
      "hasAutoPay": false,
      "source": "0",
      "emailDeliveryOption": "1",
      "mailDeliveryOption": "0",
      "creditAmount": 0,
      "quickbooksId": null,
      "recInvoiceTemplateId": "00000000000000000000",
      "financingStatus": "0",
      "netBillId": "00000000000000000000",
      "netOrgId": "00000000000000000000",
      "scheduledAmount": 0,
      "stylingId": null,
      "stylingRevision": null,
      "financingModelStatus": null,
      "financingErrorType": "0",
      "invoiceLineItems": [
        {
          "entity": "InvoiceLineItem",
          "id": "00f02QSSEGYTPEZDeik8",
          "createdTime": "2024-07-31T20:27:48.000+0000",
          "updatedTime": "2024-07-31T20:27:48.000+0000",
          "invoiceId": "00e02DTFJUMHHRGKh6zx",
          "itemId": "0ii02CTRVHZJQMRWad60",
          "quantity": 1,
          "amount": 12,
          "price": 12,
          "serviceDate": null,
          "ratePercent": null,
          "chartOfAccountId": "00000000000000000000",
          "departmentId": "00000000000000000000",
          "locationId": "00000000000000000000",
          "actgClassId": "00000000000000000000",
          "jobId": "00000000000000000000",
          "description": null,
          "taxable": false,
          "taxCode": "Non",
          "lineOrder": 0
        }
      ],
      "invoiceAdjustments": [],
      "invoiceCustomFields": []
    }
  ]
}

List Vendor Bank Accounts​

List vendor bank account objects. | key: listVendorBankAccounts

InputDefaultNotesExample
Connection
connection
/ Required
connection
 
 
 
Debug Request
boolean
debug
false
Enabling this flag will log out the current request.
 
Filters
code
filters
An array of filters to apply. See https://developer.bill.com/reference/ap-vendormgmt-listvendorbankaccount for more information. Go to Prismatic docs to see an example of how to use this input.
Max
string
/ Required
max
999
Maximum number of results to return.
999
Nested
boolean
nested
false
Set as true to include additional nested data in the response.
 
Sort
code
sort
An array of sort objects. See https://developer.bill.com/reference/ap-vendormgmt-listvendorbankaccount for more information. Go to Prismatic docs to see an example of how to use this input.
Start
string
/ Required
start
0
Index of the first result.
0

{
  "data": [
    {
      "entity": "VendorBankAccount",
      "id": "vba02BSNHVJVZPN17kxr",
      "isActive": "1",
      "createdTime": "2024-07-30T20:33:28.000+0000",
      "updatedTime": "2024-07-30T20:33:28.000+0000",
      "vendorId": "00902JIJYMCGEGI25m2l",
      "nameOnAcct": "John Doe",
      "accountNumber": "******7890",
      "routingNumber": "021000021",
      "usersId": "00602ZGNAZQYJBKLdrql",
      "status": "1",
      "isSavings": false,
      "isPersonalAcct": false,
      "intlEPaymentAcct": false,
      "intlPaymentType": "0",
      "paymentCurrency": null,
      "bankCountry": null,
      "vendorBankData": null,
      "bankAddSource": "2",
      "intlTemplateKey": null,
      "regulatory1": null,
      "regulatory2": null,
      "regulatory3": null,
      "regulatory4": null,
      "regulatory5": null,
      "regulatory6": null,
      "regulatory7": null
    }
  ]
}

List Vendors​

List vendor objects. | key: listVendors

InputDefaultNotesExample
Connection
connection
/ Required
connection
 
 
 
Debug Request
boolean
debug
false
Enabling this flag will log out the current request.
 
Filters
code
filters
An array of filters to apply. See https://developer.bill.com/reference/ap-vendormgmt-listvendor for more information. Go to Prismatic docs to see an example of how to use this input.
Max
string
/ Required
max
999
Maximum number of results to return.
999
Nested
boolean
nested
false
Set as true to include additional nested data in the response.
 
Sort
code
sort
An array of sort objects. See https://developer.bill.com/reference/ap-vendormgmt-listvendor for more information. Go to Prismatic docs to see an example of how to use this input.
Start
string
/ Required
start
0
Index of the first result.
0

{
  "data": [
    {
      "entity": "Vendor",
      "id": "00902YSABCAKZHY25m0r",
      "isActive": "1",
      "name": "Prismatic Vendor",
      "shortName": null,
      "nameOnCheck": "Prismatic Vendor",
      "companyName": "Prismatic",
      "accNumber": null,
      "taxId": null,
      "taxIdType": null,
      "track1099": false,
      "address1": null,
      "address2": null,
      "address3": null,
      "address4": null,
      "addressCity": null,
      "addressState": null,
      "addressZip": null,
      "addressCountry": null,
      "email": "example@email.com",
      "fax": null,
      "phone": null,
      "payBy": "0",
      "paymentEmail": null,
      "paymentPhone": null,
      "description": null,
      "createdTime": "2024-07-30T19:31:00.000+0000",
      "updatedTime": "2024-07-30T19:31:00.000+0000",
      "contactFirstName": null,
      "contactLastName": null,
      "mergedIntoId": "00000000000000000000",
      "accountType": "0",
      "paymentTermId": "00000000000000000000",
      "sendNotifications": true,
      "balance": 0,
      "availCredit": 0,
      "lastBalanceUpdate": null,
      "externalBillPayIn12m": null,
      "since": null,
      "payDaysBefore": null,
      "enabledCombinePayments": true,
      "hasBankAccountAutoPay": false,
      "hasRecurringPayments": false,
      "billCurrency": "USD",
      "billSyncPref": "0",
      "paymentCurrency": null,
      "prefPmtMethod": "1",
      "paymentPurpose": null,
      "bankCountry": null,
      "vendorBankAccountStatus": -1,
      "sendInviteForPrivateVendor": true,
      "vendorVCardRemitEmail": null,
      "vendorVCardStatus": "-1",
      "orgVCardStatus": "1",
      "prefRemitEmail": "0",
      "remitEmail": null,
      "processorVCardStatus": null,
      "vStatusUpdateSource": null,
      "allowConnectedVendorEditAddress": false,
      "informConnectedVendorAddressSyncModified": false,
      "intlPaymentType": "0",
      "vcardEnrollDate": null,
      "vcardDeclineDate": null,
      "isAccountNumberRequired": false,
      "largeBillerId": "00000000000000000000",
      "orgVCardOptOutCustReason": null,
      "enableFundedInvite": false,
      "lastPaymentDate": null,
      "numberOfInvitesSent": 0,
      "eligibleForEbills": false,
      "acknowledgedEbillBanner": false,
      "acknowledgedEbillError": false,
      "eBillEnablementFailed": false,
      "PaymentusMerchantId": null,
      "unmodifiedBillsCount": 0,
      "setupAutoPayPrompt": false,
      "autoPayConflict": false,
      "nameOnCheckRemediation": false,
      "autoSave": null,
      "autoSaveStatus": null,
      "creationSource": "0",
      "PaymentusPmtType": null,
      "PaymentusAcctToken": null,
      "PaymentusAcctToken2": null,
      "PaymentusAcctToken3": null,
      "stpProcessor": "0",
      "eBillEnabledStatus": "0",
      "orgVCardOptOutCustOther": null,
      "networkStatus": null,
      "vcardProcessor": "1",
      "isAddressValidated": false,
      "isSyncVendorCountryMapped": false,
      "optedOutOfVCardByOrg": false,
      "invalidCountryCurrencyAtNewVendorSync": false,
      "acctBalance": 0,
      "lastAcctBalanceUpdate": null,
      "paymentEmails": null,
      "eBillEligible": false,
      "required": []
    }
  ]
}

Raw Request​

Send raw HTTP request to Bill. | key: rawRequest

InputDefaultNotesExample
Connection
connection
/ Required
connection
 
 
 
Data
string
data
The HTTP body payload to send to the URL.
{"exampleKey": "Example Data"}
Debug Request
boolean
debugRequest
false
Enabling this flag will log out the current request.
 
File Data
string
Key Value List
fileData
File Data to be sent as a multipart form upload.
[{key: "example.txt", value: "My File Contents"}]
File Data File Names
string
Key Value List
fileDataFileNames
File names to apply to the file data inputs. Keys must match the file data keys above.
 
Form Data
string
Key Value List
formData
The Form Data to be sent as a multipart form upload.
[{"key": "Example Key", "value": new Buffer("Hello World")}]
Header
string
Key Value List
headers
A list of headers to send with the request.
User-Agent: curl/7.64.1
Max Retry Count
string
maxRetries
0
The maximum number of retries to attempt. Specify 0 for no retries.
 
Method
string
/ Required
method
The HTTP method to use.
 
Query Parameter
string
Key Value List
queryParams
A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2.
 
Response Type
string
/ Required
responseType
json
The type of data you expect in the response. You can request json, text, or binary data.
 
Retry On All Errors
boolean
retryAllErrors
false
If true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors.
 
Retry Delay (ms)
string
retryDelayMS
0
The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled.
 
Timeout
string
timeout
The maximum time that a client will await a response to its request
2000
URL
string
/ Required
url
Input the path only (/Login.json), The base URL is already included (https://api.bill.com/api/v2). For example, to connect to https://api.bill.com/api/v2/Login.json, only /Login.json is entered in this field.
/Login.json
Use Exponential Backoff
boolean
useExponentialBackoff
false
Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored.
 

Update Bill​

Update a bill object. | key: updateBill

InputDefaultNotesExample
Additional Fields
code
additionalFields
Additional fields that might not be covered by the standard inputs. See https://developer.bill.com/reference/ap-vendortransactions-updatebill for more information. Go to Prismatic docs to see an example of how to use this input.
Allow Duplicate Invoice Number
string
allowDuplicateInvNum
Allow duplicate invoice numbers.
 
Bill ID
string
/ Required
billId
Bill ID.
00n...
Bill Line Items
code
/ Required
billLineItems
An array of bill line items. See https://developer.bill.com/reference/ap-vendortransactions-updatebill for more information. Go to Prismatic docs to see an example of how to use this input.
Connection
connection
/ Required
connection
 
 
 
Debug Request
boolean
debug
false
Enabling this flag will log out the current request.
 
Due Date
string
/ Required
dueDate
Date when the bill is due. The value is in the YYYY-MM-DD format.
2021-01-01
Invoice Date
string
/ Required
invoiceDate
Date when the bill is sent. This value is in the YYYY-MM-DD format.
2021-01-01
Invoice Number
string
/ Required
invoiceNumber
User-generated invoice number. This value can be your chosen number scheme or bill due date.
01
Vendor ID
string
/ Required
vendorId
ID of the vendor.
009...

{
  "data": {
    "entity": "Bill",
    "id": "00n02XNWHOPPXWV9ewx0",
    "isActive": "1",
    "vendorId": "00902YSHZXAKZHY25m0r",
    "invoiceNumber": "01",
    "approvalStatus": "0",
    "invoiceDate": "2024-07-01",
    "dueDate": "2024-08-01",
    "glPostingDate": "2024-07-01",
    "amount": 1,
    "localAmount": null,
    "exchangeRate": null,
    "scheduledAmount": 0,
    "paidAmount": null,
    "dueAmount": 1,
    "creditAmount": 0,
    "paymentStatus": "1",
    "uiPaymentStatus": "1",
    "description": null,
    "poNumber": null,
    "createdTime": "2024-07-30T23:00:32.000+0000",
    "updatedTime": "2024-07-30T23:00:32.000+0000",
    "createdBy": "00602ZGNAZQYJBKLdrql",
    "payFromBankAccountId": "00000000000000000000",
    "payFromChartOfAccountId": "00000000000000000000",
    "paymentTermId": "00000000000000000000",
    "hasAutoPay": false,
    "eBillCreated": false,
    "invoiceProductId": "00000000000000000000",
    "chartOfAccountId": "00000000000000000000",
    "departmentId": "00000000000000000000",
    "locationId": "00000000000000000000",
    "actgClassId": "00000000000000000000",
    "source": "0",
    "numApprPolicyEx": 0,
    "useBillDesc": false,
    "defaultInvoiceNumber": false,
    "isAutoSaved": false,
    "billTemplateId": "00000000000000000000",
    "quickbooksId": null,
    "lastPaymentDate": null,
    "fullPaymentDate": null,
    "hasLinkedPurchaseOrders": false,
    "multipleBillLineItems": false,
    "item": {
      "count": 0,
      "totalAmount": 0
    },
    "expense": {
      "count": 1,
      "totalAmount": 1,
      "chartOfAccountGroup": []
    },
    "billLineItems": [
      {
        "entity": "BillLineItem",
        "id": "bli02VSXIUDVFUQd1e4s",
        "billId": "00n02XNWHOPPXWV9ewx0",
        "amount": 1,
        "chartOfAccountId": "00000000000000000000",
        "departmentId": "00000000000000000000",
        "locationId": "00000000000000000000",
        "jobId": "00000000000000000000",
        "customerId": "00000000000000000000",
        "jobBillable": false,
        "description": null,
        "createdTime": "2024-07-30T23:00:32.000+0000",
        "updatedTime": "2024-07-30T23:00:32.000+0000",
        "lineType": "1",
        "itemId": "00000000000000000000",
        "quantity": null,
        "unitPrice": null,
        "employeeId": "00000000000000000000",
        "actgClassId": "00000000000000000000",
        "purchaseOrderBillLinkId": "00000000000000000000",
        "unitOfMeasureId": "00000000000000000000",
        "lineOrder": 0
      }
    ]
  }
}

Update Customer​

Update a customer object. | key: updateCustomer

InputDefaultNotesExample
Additional Fields
code
additionalFields
Additional fields that might not be covered by the standard inputs. See https://developer.bill.com/reference/ar-customermgmt-updatecustomer for more information. Go to Prismatic docs to see an example of how to use this input.
Connection
connection
/ Required
connection
 
 
 
Customer ID
string
/ Required
customerId
ID of the customer.
0cu...
Customer Name
string
customerName
The name of the customer.
John
Debug Request
boolean
debug
false
Enabling this flag will log out the current request.
 

{
  "data": {
    "entity": "Customer",
    "id": "0cu02EAQUAPCBNTDsmzc",
    "isActive": "1",
    "createdTime": "2024-07-29T20:30:30.000+0000",
    "updatedTime": "2024-07-30T19:14:48.000+0000",
    "name": "John",
    "shortName": null,
    "parentCustomerId": "00000000000000000000",
    "companyName": "A Company",
    "contactFirstName": "John",
    "contactLastName": "Doe",
    "accNumber": null,
    "billAddress1": null,
    "billAddress2": null,
    "billAddress3": null,
    "billAddress4": null,
    "billAddressCity": null,
    "billAddressState": null,
    "billAddressCountry": null,
    "billAddressZip": null,
    "shipAddress1": null,
    "shipAddress2": null,
    "shipAddress3": null,
    "shipAddress4": null,
    "shipAddressCity": null,
    "shipAddressState": null,
    "shipAddressCountry": null,
    "shipAddressZip": null,
    "email": null,
    "phone": null,
    "altPhone": null,
    "fax": null,
    "description": null,
    "invoiceCurrency": null,
    "printAs": null,
    "mergedIntoId": "00000000000000000000",
    "hasAuthorizedToCharge": false,
    "accountType": "0",
    "paymentTermId": "00000000000000000000",
    "balance": 0,
    "availCredit": 0,
    "taxId": null,
    "hasBankAccount": false,
    "hasNetBankAccount": false,
    "hasBankAccountAutoPay": false,
    "hasCreditCard": false,
    "hasCreditCardAutoPay": false,
    "defaultDeliveryMethod": null,
    "isAutoChargeDismissed": false,
    "isTaxLiable": false,
    "creationSource": "0",
    "enabledInvoiceFinancing": false,
    "hasCustomerCard": false,
    "enabledAutoInvoiceFinancing": false
  }
}

Update Invoice​

Update an invoice object. | key: updateInvoice

InputDefaultNotesExample
Additional Fields
code
additionalFields
Additional fields that might not be covered by the standard inputs.
Connection
connection
/ Required
connection
 
 
 
Customer ID
string
/ Required
customerId
ID of the customer.
0cu...
Debug Request
boolean
debug
false
Enabling this flag will log out the current request.
 
Due Date
string
/ Required
dueDate
Date when the invoice is due. The value is in the YYYY-MM-DD format.
2024-04-10
Invoice Date
string
/ Required
invoiceDate
Date when the invoice is issued to the customer. This value is in the YYYY-MM-DD format.
2024-04-10
Invoice ID
string
/ Required
invoiceId
The ID of the invoice.
00e...
Invoice Line Items
code
/ Required
invoiceLineItems
An array of invoice line items.
Invoice Number
string
/ Required
invoiceNumber
User-generated invoice number. This value can be your chosen number scheme or invoice due date.
00e02DTF...

{
  "data": {
    "entity": "Invoice",
    "id": "00e02DTFJUMHHRGKh6zx",
    "isActive": "1",
    "createdBy": "00602ZGNAZQYJBKLdrql",
    "createdTime": "2024-07-31T16:56:53.000+0000",
    "updatedTime": "2024-07-31T20:27:48.000+0000",
    "customerId": "0cu02BLGFCGXROGGsnpx",
    "invoiceNumber": "001",
    "invoiceDate": "2024-07-22",
    "dueDate": "2024-09-08",
    "glPostingDate": "2024-07-22",
    "amount": 2199,
    "localAmount": null,
    "exchangeRate": null,
    "amountDue": 2199,
    "paymentStatus": "1",
    "description": null,
    "poNumber": null,
    "isToBePrinted": false,
    "isToBeEmailed": false,
    "lastSentTime": null,
    "itemSalesTax": "0ii02JKMRQWBGLFLadj8",
    "salesTaxPercentage": 6,
    "salesTaxTotal": 0,
    "terms": "Due upon receipt",
    "salesRep": null,
    "FOB": null,
    "shipDate": null,
    "shipMethod": null,
    "departmentId": "00000000000000000000",
    "locationId": "00000000000000000000",
    "actgClassId": "00000000000000000000",
    "jobId": "00000000000000000000",
    "payToBankAccountId": "00000000000000000000",
    "payToChartOfAccountId": "00000000000000000000",
    "invoiceTemplateId": "itm02EJBDDIGUVGSc8w1",
    "hasAutoPay": false,
    "source": "0",
    "emailDeliveryOption": "1",
    "mailDeliveryOption": "0",
    "creditAmount": 0,
    "quickbooksId": null,
    "recInvoiceTemplateId": "00000000000000000000",
    "financingStatus": "0",
    "netBillId": "00000000000000000000",
    "netOrgId": "00000000000000000000",
    "scheduledAmount": 0,
    "stylingId": null,
    "stylingRevision": null,
    "financingModelStatus": null,
    "financingErrorType": "0",
    "invoiceLineItems": [
      {
        "entity": "InvoiceLineItem",
        "id": "00f02QSSEGYTPEZDeik8",
        "createdTime": "2024-07-31T20:27:48.000+0000",
        "updatedTime": "2024-07-31T20:27:48.000+0000",
        "invoiceId": "00e02DTFJUMHHRGKh6zx",
        "itemId": "0ii02CTRVHZJQMRWad60",
        "quantity": 1,
        "amount": 12,
        "price": 12,
        "serviceDate": null,
        "ratePercent": null,
        "chartOfAccountId": "00000000000000000000",
        "departmentId": "00000000000000000000",
        "locationId": "00000000000000000000",
        "actgClassId": "00000000000000000000",
        "jobId": "00000000000000000000",
        "description": null,
        "taxable": false,
        "taxCode": "Non",
        "lineOrder": 0
      }
    ],
    "invoiceAdjustments": [],
    "invoiceCustomFields": []
  }
}

Update Vendor​

Update a vendor object. | key: updateVendor

InputDefaultNotesExample
Additional Fields
code
additionalFields
Additional fields that might not be covered by the standard inputs. See https://developer.bill.com/reference/ap-vendormgmt-updatevendor for more information. Go to Prismatic docs to see an example of how to use this input.
Connection
connection
/ Required
connection
 
 
 
Debug Request
boolean
debug
false
Enabling this flag will log out the current request.
 
Vendor Name
string
/ Required
name
Unique vendor name.
Example Vendor
Vendor ID
string
/ Required
vendorId
ID of the vendor.
009...

{
  "data": {
    "entity": "Vendor",
    "id": "00902YSABCAKZHY25m0r",
    "isActive": "1",
    "name": "Prismatic Vendor",
    "shortName": null,
    "nameOnCheck": "Prismatic Vendor",
    "companyName": "Prismatic",
    "accNumber": null,
    "taxId": null,
    "taxIdType": null,
    "track1099": false,
    "address1": null,
    "address2": null,
    "address3": null,
    "address4": null,
    "addressCity": null,
    "addressState": null,
    "addressZip": null,
    "addressCountry": null,
    "email": "example@email.com",
    "fax": null,
    "phone": null,
    "payBy": "0",
    "paymentEmail": null,
    "paymentPhone": null,
    "description": null,
    "createdTime": "2024-07-30T19:31:00.000+0000",
    "updatedTime": "2024-07-30T19:31:00.000+0000",
    "contactFirstName": null,
    "contactLastName": null,
    "mergedIntoId": "00000000000000000000",
    "accountType": "0",
    "paymentTermId": "00000000000000000000",
    "sendNotifications": true,
    "balance": 0,
    "availCredit": 0,
    "lastBalanceUpdate": null,
    "externalBillPayIn12m": null,
    "since": null,
    "payDaysBefore": null,
    "enabledCombinePayments": true,
    "hasBankAccountAutoPay": false,
    "hasRecurringPayments": false,
    "billCurrency": "USD",
    "billSyncPref": "0",
    "paymentCurrency": null,
    "prefPmtMethod": "1",
    "paymentPurpose": null,
    "bankCountry": null,
    "vendorBankAccountStatus": -1,
    "sendInviteForPrivateVendor": true,
    "vendorVCardRemitEmail": null,
    "vendorVCardStatus": "-1",
    "orgVCardStatus": "1",
    "prefRemitEmail": "0",
    "remitEmail": null,
    "processorVCardStatus": null,
    "vStatusUpdateSource": null,
    "allowConnectedVendorEditAddress": false,
    "informConnectedVendorAddressSyncModified": false,
    "intlPaymentType": "0",
    "vcardEnrollDate": null,
    "vcardDeclineDate": null,
    "isAccountNumberRequired": false,
    "largeBillerId": "00000000000000000000",
    "orgVCardOptOutCustReason": null,
    "enableFundedInvite": false,
    "lastPaymentDate": null,
    "numberOfInvitesSent": 0,
    "eligibleForEbills": false,
    "acknowledgedEbillBanner": false,
    "acknowledgedEbillError": false,
    "eBillEnablementFailed": false,
    "PaymentusMerchantId": null,
    "unmodifiedBillsCount": 0,
    "setupAutoPayPrompt": false,
    "autoPayConflict": false,
    "nameOnCheckRemediation": false,
    "autoSave": null,
    "autoSaveStatus": null,
    "creationSource": "0",
    "PaymentusPmtType": null,
    "PaymentusAcctToken": null,
    "PaymentusAcctToken2": null,
    "PaymentusAcctToken3": null,
    "stpProcessor": "0",
    "eBillEnabledStatus": "0",
    "orgVCardOptOutCustOther": null,
    "networkStatus": null,
    "vcardProcessor": "1",
    "isAddressValidated": false,
    "isSyncVendorCountryMapped": false,
    "optedOutOfVCardByOrg": false,
    "invalidCountryCurrencyAtNewVendorSync": false,
    "acctBalance": 0,
    "lastAcctBalanceUpdate": null,
    "paymentEmails": null,
    "eBillEligible": false,
    "required": []
  }
}