Billtrust

App · 21 actions

Send customers, invoices and contacts to Billtrust and read payments and remittance exports.

Actions

ActionWhat it does
Add customer noteAdd a note to a customer account.
Close invoiceClose an open invoice or credit note and record why.
Create contactAdd a contact to a customer account, for Collections reminders and calls.
Create customerAdd a customer account to Billtrust.
Create export scheduleSet up a recurring payment export that runs every so many minutes.
Create invoiceAdd an invoice or credit note to Billtrust.
Delete export scheduleDelete an export schedule.
Find paymentsFind payment and remittance records by date and field values.
Get contactGet a contact by its reference.
Get customerGet a customer account and its notes.
Get customer noteGet one note on a customer account by its reference.
Get export run dataGet the payment rows a completed export run produced.
Get invoiceGet an invoice or credit note, including whether it is open or closed.
Get latest export runGet the most recent finished run of an export schedule, and whether it completed or failed.
Get payment fieldsList the payment fields you can return and filter on, for each data source.
List customer notesList the notes on a customer account.
List export schedulesList your recurring payment export schedules.
List invoice PDFsList the PDF files attached to an invoice or credit note.
Update contactChange a contact.
Update customerChange a customer account.
Update invoiceChange 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 numberaccount_numbertextRequired
Your own unique number for the customer account, such as its number in your ERP.
Note referencereferencetextRequired
Your own unique reference for the note.
NotebodytextRequired
The note.
Subjectsubjecttext
The note's subject line.
Note typenote_typetext
A label for the kind of note, such as `collections`.
Effective dateeffective_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 numberdocument_numbertextRequired
Your own unique number for the invoice or credit note.
Reasonclosure_reasontextRequired
Why the invoice is closed.One of: paid, write_off (Write off), contra, adjustment, other.
Closed atclosure_datedate and time
When it was closed. Defaults to now.
Notesnotestext
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 referencereferencetextRequired
Your own unique reference for the contact.
Customer account numberaccount_numbertext
The account number of the customer this contact belongs to.
First namefirst_nametext
First name.
Last namelast_nametext
Last name.
Emailemailtext
Email address.
Phonephonetext
Phone number.
Mobile phonemobile_phonetext
Mobile number.
Job titletitletext
Job title.
Departmentdepartmenttext
Department.
Rolefunctiontext
The contact's role, such as accountant.
Primary contactis_primarytrue/false
Turn on to make this the customer's primary contact for Collections.
Languagelanguagetext
Two-letter language code, such as `en`.
Notesnotestext
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 numberaccount_numbertextRequired
Your own unique number for the customer account, such as its number in your ERP.
NamenametextRequired
The customer's name.
Emailemailtext
The customer's billing email address.
Phonephonetext
The customer's phone number.
Currencycurrencytext
Three-letter currency code, such as `USD`. Needed when your Billtrust account uses the basic currency model; it can't be changed later.
Payment termspayment_termstext
Payment terms, such as `NET30`.
Credit limitcredit_limitnumber
The customer's credit limit.
Languagelanguagetext
Two-letter language code for Collections emails, such as `en`.
Display referencedisplay_referencetext
A short reference shown in Billtrust and used to match payments.
Account groupaccount_grouptext
A group or segment label.
Parent account numberparent_account_numbertext
The account number of this customer's parent account.
VAT numbervattext
VAT registration number.
Descriptiondescriptiontext
A description of the customer.
Address line 1address1text
Billing street address.
Address line 2address2text
Billing address line 2.
Citycitytext
Billing city.
Statestatetext
Billing state or province.
Postal codeziptext
Billing postal code.
Countrycountrytext
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 sourcesourcetextRequired
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.
Namenametext
A name for the schedule.
First runfirst_run_atdate and time
When to run it first. Defaults to one interval from now.
Filter fieldfilter_fieldtext
A field to filter on, such as `status`. Get Payment Fields lists the fields you can filter on.
Filter operatorfilter_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 valuefilter_valuetext
The value to compare with.
Fieldsfieldslist
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 numberdocument_numbertextRequired
Your own unique number for the invoice or credit note.
Customer account numberaccount_numbertextRequired
The account number of the customer the invoice belongs to.
Typedocument_typetext
Invoice, credit note or other.One of: invoice, credit_note (Credit note), other. Default: invoice.
Invoice dateinvoice_datedateRequired
The date of the invoice.
Due datedue_datedateRequired
The date payment is due.
Invoice numberinvoice_numtext
The invoice number customers see. Needed to match payments in CashApp.
Currencycurrencytext
Three-letter currency code, such as `USD`. Enter it with both amounts.
Original amountoriginal_amountnumber
The invoice's original total.
Amount dueamount_duenumber
The amount still owed. Zero closes the invoice.
PO numberpo_numbertext
The customer's purchase order number.
Credits invoiceapplies_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 scheduleschedule_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 sourcesourcetextRequired
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 datefrom_datedate
Payments created on or after this date.
To dateto_datedate
Payments created on or before this date.
Filter fieldfilter_fieldtext
A field to filter on, such as `status`. Get Payment Fields lists the fields you can filter on.
Filter operatorfilter_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 valuefilter_valuetext
The value to compare with.
Fieldsfieldslist
The fields to return. Leave empty for the standard payment fields.
Limitlimitnumber
How many payments to return, up to 100,000. Defaults to 500.From 1 to 100000.
Next page cursorcursortext
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 referencereferencetextRequired
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 numberaccount_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 numberaccount_numbertextRequired
Your own unique number for the customer account, such as its number in your ERP.
Note referencereferencetextRequired
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 scheduleschedule_idtextRequired
The export schedule.
Run IDrun_idtext
The run to read. Leave empty for the most recent completed run.
Limitlimitnumber
How many rows to return, up to 100,000. Defaults to 500.From 1 to 100000.
Next page cursorcursortext
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 numberdocument_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 scheduleschedule_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 numberaccount_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 numberdocument_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 referencereferencetextRequired
Your own unique reference for the contact.
Customer account numberaccount_numbertext
The account number of the customer this contact belongs to.
First namefirst_nametext
First name.
Last namelast_nametext
Last name.
Emailemailtext
Email address.
Phonephonetext
Phone number.
Mobile phonemobile_phonetext
Mobile number.
Job titletitletext
Job title.
Departmentdepartmenttext
Department.
Rolefunctiontext
The contact's role, such as accountant.
Primary contactis_primarytrue/false
Turn on to make this the customer's primary contact for Collections.
Languagelanguagetext
Two-letter language code, such as `en`.
Notesnotestext
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 numberaccount_numbertextRequired
Your own unique number for the customer account, such as its number in your ERP.
Namenametext
The customer's name.
Emailemailtext
The customer's billing email address.
Phonephonetext
The customer's phone number.
Currencycurrencytext
Three-letter currency code, such as `USD`. Needed when your Billtrust account uses the basic currency model; it can't be changed later.
Payment termspayment_termstext
Payment terms, such as `NET30`.
Credit limitcredit_limitnumber
The customer's credit limit.
Languagelanguagetext
Two-letter language code for Collections emails, such as `en`.
Display referencedisplay_referencetext
A short reference shown in Billtrust and used to match payments.
Account groupaccount_grouptext
A group or segment label.
Parent account numberparent_account_numbertext
The account number of this customer's parent account.
VAT numbervattext
VAT registration number.
Descriptiondescriptiontext
A description of the customer.
Address line 1address1text
Billing street address.
Address line 2address2text
Billing address line 2.
Citycitytext
Billing city.
Statestatetext
Billing state or province.
Postal codeziptext
Billing postal code.
Countrycountrytext
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 numberdocument_numbertextRequired
Your own unique number for the invoice or credit note.
Customer account numberaccount_numbertext
The account number of the customer the invoice belongs to.
Typedocument_typetext
Invoice, credit note or other.One of: invoice, credit_note (Credit note), other. Default: invoice.
Invoice dateinvoice_datedate
The date of the invoice.
Due datedue_datedate
The date payment is due.
Invoice numberinvoice_numtext
The invoice number customers see. Needed to match payments in CashApp.
Currencycurrencytext
Three-letter currency code, such as `USD`. Enter it with both amounts.
Original amountoriginal_amountnumber
The invoice's original total.
Amount dueamount_duenumber
The amount still owed. Zero closes the invoice.
PO numberpo_numbertext
The customer's purchase order number.
Credits invoiceapplies_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"
  }
}

On this page