Skip to main content

RevUp Finance API Quick Start Guide - Synchronous Flow

Objectives​

This guide shows you how to use RevUp's APIs to manage invoices and upload proof of payments.

Note: This guide needs to be done step by step, and should be done in the order shown below.

Before You Begin​

Prerequisites​

  • Active RevUp Finance account

  • API Authorization token

  • Supported file formats:

    • Proof of Payment (PDF, JPG, PNG)
    • Bank statements (GCASH, BPI, UBP)

    High Level Flow​

Note that this tutorial is for synchronous flow. For asynchronous flow, please refer to the Aynchronous Call page.

synchronous-flow

Required Permissions​

  • Invoice Management permissions
  • Payment Processing access
  • Bank reconciliation rights

Out of Scope​

This tutorial is only going to use 1 API call (Proof of Payment with Invoice). For this tutorial, we will not be using the other API calls. Especially uploading a bank statement and reconciling the proof of payment with the bank statement (which will be done manually).

Setting Up Your Environment​

1. Authentication Setup​

# Include in all API requests
x-api-key: <your-api-key>

2. API Base URL​

Production: https://partner-api.revup.finance
Sandbox: https://partner-api-dev.revup.finance

3. Sample Files to test with:​

Download the following files to be used for testing:

Upload a Proof of Payment​

Call the Proof of Payment with Invoice endpoint to create a new invoice and upload a proof of payment in the same call.

POST /proof_of_payment_with_invoice

type: form-data

invoice:

{
    "number": "INV-001",
    "dueDate": "2024-09-30T14:15:22Z",
    "status": "DRAFT",
    "total": 1,
    "subTotal": 1,
    "items": [
        {
            "price": 51.68,
            "quantity": 1,
            "subTotal": 0,
            "total": 51.68
        }
    ],
    "customer": {
        "firstName": "John",
        "lastName": "Doe",
        "email": "john.doe@example.com",
    },
    "memo": "string",
    "attachPastDue": true,
    "createdDate": "2024-11-30T14:15:22Z" // replace with the current date
}

file: <sample-gcash-txn.jpg>

It should look like this when you're requesting with Postman:

alt text

Make sure to mark the invoice Content-Type as application/json.

alt text

Once the invoice is created, you can see the invoice details in your RevUp Finance account. It will look like this:

alt text

The invoice will contain the attached proof of payment in the Invoice page.

Updating Invoice Status​

Once the customer has uploaded proof of payment, you can now update the invoice status to PAID assuming that you have already confirmed the payment with the customer.

PATCH /invoices/{invoiceId}

body:
{
    "status": "PAID"
}

Once the invoice status is updated to PAID, the invoice will now be shown in the Paid Invoices section in your RevUp Finance account.

alt text

Upon marking the invoice as PAID, it will now also trigger the bank reconciliation process. Which reflects a new reconciliation record in your RevUp Finance account.

alt text

Upload a Bank Statement​

Now that you have uploaded a proof of payment, you can now upload a bank statement to reconcile the payment with the bank statement.

Go to the Ledger page in your RevUp Finance account and click the Bulk Upload button in the top right corner.

alt text

Then Select the type of bank statement file you want to upload. In this case, we will select GCash.

alt text

Then, select browse file and upload the sample bank statement file.

alt text

Then enter the password if there is one. In this case, the password is bernardo2228.

alt text

Note: If there is no password, you can leave it blank.

Once uploaded, the bank statement will now be shown in the ledger page in your RevUp Finance account.

alt text

Note: If you have uploaded a different bank statement (e.g. BPI, UBP, etc.), it will consolidate the bank statement into a single record.

Also, upon uploading the bank statement, it will now trigger the bank reconciliation process. Which reflects a new reconciliation record in your RevUp Finance account.

Reconcile Proof of Payment with Bank Statement​

Now that you have uploaded a proof of payment and a bank statement, you can now reconcile the proof of payment with the bank statement.

In the portal, you can see the automatically reconciled items in the Recon page. It looks like this:

alt text

You can just click the Reconcile button to confirm the reconciliation.

Then, in the RevUp Finance portal Ledger page, it will now look like this:

alt text