API workflows

Use these workflows to list or download invoices:

List your bills

Use this workflow to list invoices, credit memos, and debit memos:

1. List contracts that a user has access to. Use the contractId value returned by this request in the next step.

2. List bills for the contract keyed by the contractId you retrieved previously.

Download a bill file

Use this workflow to download an invoice, a credit memo, or a debit memo file:

1. List contracts that a user has access to. Use the contractId value returned by this request in the next steps.

2. List account's bills or List contracts and List contract's bills. Use the invoiceId value assigned to the document that you want to download in the next step.

3. Download a bill file keyed by the invoiceId and contractId values you retrieved previously.

Use these workflows to manage notifications:

Create a notification

Use this workflow to create a notification:

1. List contracts that a user has access to. Use the contractId values returned by this request in the next step.

2. Create a notification for the contracts keyed by the contractId values you retrieved previously.

Get a notification

Use this workflow to get a notification

1. List notifications for an account. Use the notificationId value returned by this request in the next step.

2. Get a notification to access the notification keyed by the notificationId you retrieved previously.

Modify a notification

Use this workflow to modify a notification:

1. List notifications for an account. Use the notificationId value returned by this request in the next steps.

2. Get a notification to access the notification keyed by the specificnotificationId you retrieved previously.

3. Modify a notification keyed by the specificnotificationId you retrieved previously.

Remove a notification

Use this workflow to remove a notification:

1. List notifications for an account. Use the notificationId value returned by this request in the next step.

2. Remove a notification keyed by the specificnotificationId you retrieved previously.