Billtrust
App · 21 actions
Send customers, invoices and contacts to Billtrust and read payments and remittance exports.
Actions
| Action | What it does |
|---|---|
| Add customer note | Add a note to a customer account. |
| Close invoice | Close an open invoice or credit note and record why. |
| Create contact | Add a contact to a customer account, for Collections reminders and calls. |
| Create customer | Add a customer account to Billtrust. |
| Create export schedule | Set up a recurring payment export that runs every so many minutes. |
| Create invoice | Add an invoice or credit note to Billtrust. |
| Delete export schedule | Delete an export schedule. |
| Find payments | Find payment and remittance records by date and field values. |
| Get contact | Get a contact by its reference. |
| Get customer | Get a customer account and its notes. |
| Get customer note | Get one note on a customer account by its reference. |
| Get export run data | Get the payment rows a completed export run produced. |
| Get invoice | Get an invoice or credit note, including whether it is open or closed. |
| Get latest export run | Get the most recent finished run of an export schedule, and whether it completed or failed. |
| Get payment fields | List the payment fields you can return and filter on, for each data source. |
| List customer notes | List the notes on a customer account. |
| List export schedules | List your recurring payment export schedules. |
| List invoice PDFs | List the PDF files attached to an invoice or credit note. |
| Update contact | Change a contact. |
| Update customer | Change a customer account. |
| Update invoice | Change an invoice or credit note. |
Add customer note
Add a note to a customer account. Notes can't be changed or deleted later.
Inputs
- Account number
account_numbertextRequired - Your own unique number for the customer account, such as its number in your ERP.
- Note reference
referencetextRequired - Your own unique reference for the note.
- Note
bodytextRequired - The note.
- Subject
subjecttext - The note's subject line.
- Note type
note_typetext - A label for the kind of note, such as `collections`.
- Effective date
effective_datedate and time - When the note takes effect. Defaults to now.
Outputs
dataobject- The response from Billtrust.
Example output
{
"data": {
"body": "example",
"effective_date": "example",
"note_type": "example",
"reference": "example",
"subject": "example"
}
}Close invoice
Close an open invoice or credit note and record why.
Inputs
- Document number
document_numbertextRequired - Your own unique number for the invoice or credit note.
- Reason
closure_reasontextRequired - Why the invoice is closed.One of:
paid,write_off(Write off),contra,adjustment,other. - Closed at
closure_datedate and time - When it was closed. Defaults to now.
- Notes
notestext - A note to keep with the closure.
Outputs
dataobject- The response from Billtrust.
Example output
{
"data": {
"account_number": "example",
"currency": "example",
"denomination": 1,
"document_number": "example",
"document_type": "example",
"due_date": "example",
"invoice_date": "example",
"invoice_num": "example",
"original_denomination": 1,
"status": "example"
}
}Create contact
Add a contact to a customer account, for Collections reminders and calls.
Inputs
- Contact reference
referencetextRequired - Your own unique reference for the contact.
- Customer account number
account_numbertext - The account number of the customer this contact belongs to.
- First name
first_nametext - First name.
- Last name
last_nametext - Last name.
- Email
emailtext - Email address.
- Phone
phonetext - Phone number.
- Mobile phone
mobile_phonetext - Mobile number.
- Job title
titletext - Job title.
- Department
departmenttext - Department.
- Role
functiontext - The contact's role, such as accountant.
- Primary contact
is_primarytrue/false - Turn on to make this the customer's primary contact for Collections.
- Language
languagetext - Two-letter language code, such as `en`.
- Notes
notestext - Notes about this contact.
Outputs
dataobject- The response from Billtrust.
Example output
{
"data": {
"account_number": "example",
"email": "example",
"first_name": "example",
"is_primary": true,
"last_name": "example",
"phone": "example",
"reference": "example"
}
}Create customer
Add a customer account to Billtrust. Fails if the account number is already in use.
Inputs
- Account number
account_numbertextRequired - Your own unique number for the customer account, such as its number in your ERP.
- Name
nametextRequired - The customer's name.
- Email
emailtext - The customer's billing email address.
- Phone
phonetext - The customer's phone number.
- Currency
currencytext - Three-letter currency code, such as `USD`. Needed when your Billtrust account uses the basic currency model; it can't be changed later.
- Payment terms
payment_termstext - Payment terms, such as `NET30`.
- Credit limit
credit_limitnumber - The customer's credit limit.
- Language
languagetext - Two-letter language code for Collections emails, such as `en`.
- Display reference
display_referencetext - A short reference shown in Billtrust and used to match payments.
- Account group
account_grouptext - A group or segment label.
- Parent account number
parent_account_numbertext - The account number of this customer's parent account.
- VAT number
vattext - VAT registration number.
- Description
descriptiontext - A description of the customer.
- Address line 1
address1text - Billing street address.
- Address line 2
address2text - Billing address line 2.
- City
citytext - Billing city.
- State
statetext - Billing state or province.
- Postal code
ziptext - Billing postal code.
- Country
countrytext - Billing country as a two-letter code, such as `US`.
Outputs
dataobject- The response from Billtrust.
Example output
{
"data": {
"account_number": "example",
"currency": "example",
"email": "example",
"name": "example",
"notes": [
{}
],
"payment_terms": "example",
"status": "example"
}
}Create export schedule
Set up a recurring payment export that runs every so many minutes.
Inputs
- Data source
sourcetextRequired - Which payment data to read: cash application payments (cashapp), invoice and payment data (iandp) or Billtrust Payment Network data (bpn).One of:
cashapp,iandp,bpn. - Every (minutes)
interval_minutesnumberRequired - How often to run the export, in minutes. At least 5.At least 5.
- Name
nametext - A name for the schedule.
- First run
first_run_atdate and time - When to run it first. Defaults to one interval from now.
- Filter field
filter_fieldtext - A field to filter on, such as `status`. Get Payment Fields lists the fields you can filter on.
- Filter operator
filter_operatortext - How to compare the field with the value. In and Not in take several values separated by commas.One of:
eq,neq,gt,gte,lt,lte,in,nin. Default:eq. - Filter value
filter_valuetext - The value to compare with.
- Fields
fieldslist - The fields to return. Leave empty for the standard payment fields.
Outputs
dataobject- The response from Billtrust.
Example output
{
"data": {
"createdAt": "example",
"fields": [
"example"
],
"filters": {},
"id": "example",
"intervalMs": 1,
"nextRunAt": "example",
"scheduleName": "example",
"source": "example"
}
}Create invoice
Add an invoice or credit note to Billtrust. Fails if the document number is already in use.
Inputs
- Document number
document_numbertextRequired - Your own unique number for the invoice or credit note.
- Customer account number
account_numbertextRequired - The account number of the customer the invoice belongs to.
- Type
document_typetext - Invoice, credit note or other.One of:
invoice,credit_note(Credit note),other. Default:invoice. - Invoice date
invoice_datedateRequired - The date of the invoice.
- Due date
due_datedateRequired - The date payment is due.
- Invoice number
invoice_numtext - The invoice number customers see. Needed to match payments in CashApp.
- Currency
currencytext - Three-letter currency code, such as `USD`. Enter it with both amounts.
- Original amount
original_amountnumber - The invoice's original total.
- Amount due
amount_duenumber - The amount still owed. Zero closes the invoice.
- PO number
po_numbertext - The customer's purchase order number.
- Credits invoice
applies_to_invoicetext - For a credit note: the number of the invoice it credits.
Outputs
dataobject- The response from Billtrust.
Example output
{
"data": {
"account_number": "example",
"currency": "example",
"denomination": 1,
"document_number": "example",
"document_type": "example",
"due_date": "example",
"invoice_date": "example",
"invoice_num": "example",
"original_denomination": 1,
"status": "example"
}
}Delete export schedule
Delete an export schedule. Past runs and their data stay available.
Inputs
- Export schedule
schedule_idtextRequired - The export schedule.
Outputs
dataobject- The response from Billtrust.
Example output
{
"data": {}
}Find payments
Find payment and remittance records by date and field values. Billtrust leaves out payments an export schedule has already delivered.
Inputs
- Data source
sourcetextRequired - Which payment data to read: cash application payments (cashapp), invoice and payment data (iandp) or Billtrust Payment Network data (bpn).One of:
cashapp,iandp,bpn. - From date
from_datedate - Payments created on or after this date.
- To date
to_datedate - Payments created on or before this date.
- Filter field
filter_fieldtext - A field to filter on, such as `status`. Get Payment Fields lists the fields you can filter on.
- Filter operator
filter_operatortext - How to compare the field with the value. In and Not in take several values separated by commas.One of:
eq,neq,gt,gte,lt,lte,in,nin. Default:eq. - Filter value
filter_valuetext - The value to compare with.
- Fields
fieldslist - The fields to return. Leave empty for the standard payment fields.
- Limit
limitnumber - How many payments to return, up to 100,000. Defaults to 500.From 1 to 100000.
- Next page cursor
cursortext - The cursor from the previous page's pagination, to get the next page.
Outputs
dataobject- The response from Billtrust.
Example output
{
"data": {
"data": [
{}
],
"pagination": {
"cursor": "example",
"hasMore": true,
"rowCount": 1
}
}
}Get contact
Get a contact by its reference.
Inputs
- Contact reference
referencetextRequired - Your own unique reference for the contact.
Outputs
dataobject- The response from Billtrust.
Example output
{
"data": {
"account_number": "example",
"email": "example",
"first_name": "example",
"is_primary": true,
"last_name": "example",
"phone": "example",
"reference": "example"
}
}Get customer
Get a customer account and its notes.
Inputs
- Account number
account_numbertextRequired - Your own unique number for the customer account, such as its number in your ERP.
Outputs
dataobject- The response from Billtrust.
Example output
{
"data": {
"account_number": "example",
"currency": "example",
"email": "example",
"name": "example",
"notes": [
{}
],
"payment_terms": "example",
"status": "example"
}
}Get customer note
Get one note on a customer account by its reference.
Inputs
- Account number
account_numbertextRequired - Your own unique number for the customer account, such as its number in your ERP.
- Note reference
referencetextRequired - The note's reference.
Outputs
dataobject- The response from Billtrust.
Example output
{
"data": {
"body": "example",
"effective_date": "example",
"note_type": "example",
"reference": "example",
"subject": "example"
}
}Get export run data
Get the payment rows a completed export run produced. Data is kept for 90 days.
Inputs
- Export schedule
schedule_idtextRequired - The export schedule.
- Run ID
run_idtext - The run to read. Leave empty for the most recent completed run.
- Limit
limitnumber - How many rows to return, up to 100,000. Defaults to 500.From 1 to 100000.
- Next page cursor
cursortext - The cursor from the previous page's pagination, to get the next page.
Outputs
dataobject- The response from Billtrust.
Example output
{
"data": {
"data": [
{}
],
"pagination": {
"cursor": "example",
"hasMore": true,
"rowCount": 1
},
"runId": "example"
}
}Get invoice
Get an invoice or credit note, including whether it is open or closed.
Inputs
- Document number
document_numbertextRequired - Your own unique number for the invoice or credit note.
Outputs
dataobject- The response from Billtrust.
Example output
{
"data": {
"account_number": "example",
"currency": "example",
"denomination": 1,
"document_number": "example",
"document_type": "example",
"due_date": "example",
"invoice_date": "example",
"invoice_num": "example",
"original_denomination": 1,
"status": "example"
}
}Get latest export run
Get the most recent finished run of an export schedule, and whether it completed or failed.
Inputs
- Export schedule
schedule_idtextRequired - The export schedule.
Outputs
dataobject- The response from Billtrust.
Example output
{
"data": {
"completedAt": "example",
"errorDetail": "example",
"errorStage": "example",
"rowCount": 1,
"runId": "example",
"scheduleId": "example",
"startedAt": "example",
"status": "example"
}
}Get payment fields
List the payment fields you can return and filter on, for each data source.
Inputs
None.
Outputs
dataobject- The response from Billtrust.
Example output
{
"data": {
"fields": {},
"filters": {},
"sources": [
"example"
],
"version": "example"
}
}List customer notes
List the notes on a customer account.
Inputs
- Account number
account_numbertextRequired - Your own unique number for the customer account, such as its number in your ERP.
Outputs
datalist- The response from Billtrust.
Example output
{
"data": [
{
"body": "example",
"effective_date": "example",
"note_type": "example",
"reference": "example",
"subject": "example"
}
]
}List export schedules
List your recurring payment export schedules.
Inputs
None.
Outputs
dataobject- The response from Billtrust.
Example output
{
"data": {
"data": [
{
"createdAt": "example",
"fields": [
"example"
],
"filters": {},
"id": "example",
"intervalMs": 1,
"nextRunAt": "example",
"scheduleName": "example",
"source": "example"
}
]
}
}List invoice PDFs
List the PDF files attached to an invoice or credit note.
Inputs
- Document number
document_numbertextRequired - Your own unique number for the invoice or credit note.
Outputs
dataobject- The response from Billtrust.
Example output
{
"data": {
"attachments": [
{}
],
"document_number": "example"
}
}Update contact
Change a contact. Only the fields you fill in change.
Inputs
- Contact reference
referencetextRequired - Your own unique reference for the contact.
- Customer account number
account_numbertext - The account number of the customer this contact belongs to.
- First name
first_nametext - First name.
- Last name
last_nametext - Last name.
- Email
emailtext - Email address.
- Phone
phonetext - Phone number.
- Mobile phone
mobile_phonetext - Mobile number.
- Job title
titletext - Job title.
- Department
departmenttext - Department.
- Role
functiontext - The contact's role, such as accountant.
- Primary contact
is_primarytrue/false - Turn on to make this the customer's primary contact for Collections.
- Language
languagetext - Two-letter language code, such as `en`.
- Notes
notestext - Notes about this contact.
Outputs
dataobject- The response from Billtrust.
Example output
{
"data": {
"account_number": "example",
"email": "example",
"first_name": "example",
"is_primary": true,
"last_name": "example",
"phone": "example",
"reference": "example"
}
}Update customer
Change a customer account. Only the fields you fill in change.
Inputs
- Account number
account_numbertextRequired - Your own unique number for the customer account, such as its number in your ERP.
- Name
nametext - The customer's name.
- Email
emailtext - The customer's billing email address.
- Phone
phonetext - The customer's phone number.
- Currency
currencytext - Three-letter currency code, such as `USD`. Needed when your Billtrust account uses the basic currency model; it can't be changed later.
- Payment terms
payment_termstext - Payment terms, such as `NET30`.
- Credit limit
credit_limitnumber - The customer's credit limit.
- Language
languagetext - Two-letter language code for Collections emails, such as `en`.
- Display reference
display_referencetext - A short reference shown in Billtrust and used to match payments.
- Account group
account_grouptext - A group or segment label.
- Parent account number
parent_account_numbertext - The account number of this customer's parent account.
- VAT number
vattext - VAT registration number.
- Description
descriptiontext - A description of the customer.
- Address line 1
address1text - Billing street address.
- Address line 2
address2text - Billing address line 2.
- City
citytext - Billing city.
- State
statetext - Billing state or province.
- Postal code
ziptext - Billing postal code.
- Country
countrytext - Billing country as a two-letter code, such as `US`.
Outputs
dataobject- The response from Billtrust.
Example output
{
"data": {
"account_number": "example",
"currency": "example",
"email": "example",
"name": "example",
"notes": [
{}
],
"payment_terms": "example",
"status": "example"
}
}Update invoice
Change an invoice or credit note. Only the fields you fill in change; an amount due of zero closes it, and a closed one with an amount due reopens.
Inputs
- Document number
document_numbertextRequired - Your own unique number for the invoice or credit note.
- Customer account number
account_numbertext - The account number of the customer the invoice belongs to.
- Type
document_typetext - Invoice, credit note or other.One of:
invoice,credit_note(Credit note),other. Default:invoice. - Invoice date
invoice_datedate - The date of the invoice.
- Due date
due_datedate - The date payment is due.
- Invoice number
invoice_numtext - The invoice number customers see. Needed to match payments in CashApp.
- Currency
currencytext - Three-letter currency code, such as `USD`. Enter it with both amounts.
- Original amount
original_amountnumber - The invoice's original total.
- Amount due
amount_duenumber - The amount still owed. Zero closes the invoice.
- PO number
po_numbertext - The customer's purchase order number.
- Credits invoice
applies_to_invoicetext - For a credit note: the number of the invoice it credits.
Outputs
dataobject- The response from Billtrust.
Example output
{
"data": {
"account_number": "example",
"currency": "example",
"denomination": 1,
"document_number": "example",
"document_type": "example",
"due_date": "example",
"invoice_date": "example",
"invoice_num": "example",
"original_denomination": 1,
"status": "example"
}
}