Skip to main content
API docs by Redocly

RevUp Finance API (1.0.0)

Download OpenAPI specification:Download

RevUp Finance Support: hello@revup.finance

API for RevUp Finance services

API Key Request

Invoice

Invoice management operations

Create a new invoice

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required
number
required
string
dueDate
required
string <date-time>
status
required
string
Default: "DRAFT"
Value: "DRAFT"
total
required
number
subTotal
required
number
required
Array of objects (InvoiceItem)
object (Customer)
memo
string
attachPastDue
boolean
Default: true
createdDate
required
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "number": "INV-001",
  • "dueDate": "2024-09-30T14:15:22Z",
  • "status": "DRAFT",
  • "total": 1,
  • "subTotal": 1,
  • "items": [
    ],
  • "customer": {
    },
  • "memo": "string",
  • "attachPastDue": true,
  • "createdDate": "2024-11-30T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "res": {
    }
}

Get invoice by ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "merchantId": "string",
  • "number": "string",
  • "dueDate": "2019-08-24T14:15:22Z",
  • "status": "DRAFT",
  • "total": 0,
  • "subTotal": 0,
  • "items": [
    ],
  • "customer": {
    },
  • "memo": "string",
  • "attachPastDue": true,
  • "createdDate": "2019-08-24T14:15:22Z"
}

Cancel an invoice

Authorizations:
ApiKeyAuth
path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "updated": {
    }
}

Update invoice status (Will trigger reconciliation)

Authorizations:
ApiKeyAuth
path Parameters
id
required
string <uuid>
Request Body schema: application/json
required
status
string
Enum: "PAID" "PAID_IN_CASH" "PARTIAL"

Responses

Request samples

Content type
application/json
{
  • "status": "PAID"
}

Response samples

Content type
application/json
{
  • "updated": {
    }
}

Proof of Payment OCR

Proof of payment processing operations

Create an invoice and upload a proof of payment simultaneously

Authorizations:
ApiKeyAuth
Request Body schema: multipart/form-data
required
invoice
string

JSON string containing the invoice data

file
string <binary>

Proof of Payment file (PDF, JPG, or PNG)

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "invoice": {
    },
  • "proof_of_payment": {
    }
}

Upload a proof of payment for an invoice

Authorizations:
ApiKeyAuth
path Parameters
id
required
string <uuid>
Request Body schema: multipart/form-data
required
file
string <binary>

Proof of Payment file (PDF, JPG, or PNG)

Responses

Response samples

Content type
application/json
{
  • "link": "http://example.com",
  • "document_analysis": {
    }
}

Get all proof of payments for an invoice

Authorizations:
ApiKeyAuth
path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Update proof of payment status and details

Authorizations:
ApiKeyAuth
path Parameters
id
required
string <uuid>
Request Body schema: application/json
required
Array
file_name
string
pop_receiving_account_number
string
pop_receiving_bank_name
string
pop_receiving_mobile_number
string
pop_receiving_name
string
pop_sending_amount
string
pop_sending_bank_name
string
pop_sending_date
string
pop_sending_name
string
pop_sending_reference_number
string
pop_sending_time
string

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "updated": [
    ]
}