Skip to main content

​
Overview

This section contains endpoints for billing finance data in the accounts payable module.

​
Billing Finance View

​
GET /api/accounts-payable/billing/finance/view

Retrieves the billing finance view grid data. This endpoint provides a comprehensive view of billing finance information.

​
Authentication

This endpoint requires authentication. Include a valid bearer token in the Authorization header.

​
Query Parameters

​
TypeFilter
integer
required
Filter type for date range:
  • 1 - Previous day
  • 2 - Previous month
  • 3 - Current month
  • 4 - Last year
  • 5 - Full month by year (requires Month and Year parameters)
  • 6 - Custom
  • 7 - All records
​
Month
integer
Specific month to search. Valid values: 1-12. Required when TypeFilter is 5.
​
Year
integer
Specific year to search. Valid values from previous year onwards. Required when TypeFilter is 5.
​
Page
integer
default:"1"
Page number, starting from 1.
​
PagSize
integer
Number of records to retrieve per page.

​
Example Request

curl -X GET "https://api.example.com/api/accounts-payable/billing/finance/view?TypeFilter=3&Page=1&PagSize=50" \
  -H "Authorization: Basic <base64-credentials>" \
  -H "Content-Type: application/json"

​
Billing Finance Purchase Orders

​
GET /api/accounts-payable/billing/finance/order-purchase

Retrieves the billing finance view for purchase orders (órdenes de compra). This endpoint provides financial information related to purchase orders.

​
Authentication

This endpoint requires authentication. Include a valid bearer token in the Authorization header.

​
Query Parameters

​
TypeFilter
integer
required
Filter type for date range:
  • 1 - Previous day
  • 2 - Previous month
  • 3 - Current month
  • 4 - Last year
  • 5 - Full month by year (requires Month and Year parameters)
  • 6 - Custom
  • 7 - All records
​
Month
integer
Specific month to search. Valid values: 1-12. Required when TypeFilter is 5.
​
Year
integer
Specific year to search. Valid values from previous year onwards. Required when TypeFilter is 5.
​
Page
integer
default:"1"
Page number, starting from 1.
​
PagSize
integer
Number of records to retrieve per page.

​
Example Request

curl -X GET "https://api.example.com/api/accounts-payable/billing/finance/order-purchase?TypeFilter=3&Page=1&PagSize=50" \
  -H "Authorization: Basic <base64-credentials>" \
  -H "Content-Type: application/json"

​
Common Response Schema

Both endpoints return a ResultDataGridModel object with the following structure:
​
currentPage
integer
required
Current page number
​
gridName
string
required
Name of the grid
​
gridId
integer
required
Unique identifier for the grid
​
totalRecordsReturned
integer
required
Number of records returned in current response
​
totalPages
integer
required
Total number of pages available
​
totalRecords
integer
required
Total number of records available
​
dataRecord
object
required
Contains the actual grid data

​
Common Response Codes

  • 200 - Success
  • 401 - Unauthorized - Authentication token is missing or invalid
  • 500 - Internal Server Error

​
Caching

Both endpoints have response caching enabled with a duration of 900 seconds (15 minutes).

​
Example Response

{
  "currentPage": 1,
  "gridName": "Billing Finance View",
  "gridId": 12346,
  "totalRecordsReturned": 50,
  "totalPages": 8,
  "totalRecords": 392,
  "dataRecord": {
    "fields": [
      {
        "id": 1,
        "label": "Order Number",
        "name": "orderNumber",
        "order": 1,
        "type": "string",
        "visible": true,
        "width": 150
      },
      {
        "id": 2,
        "label": "Amount",
        "name": "amount",
        "order": 2,
        "type": "decimal",
        "visible": true,
        "width": 120
      }
    ],
    "rows": [
      {
        "orderNumber": "PO-2024-001",
        "amount": 1250.50
      },
      {
        "orderNumber": "PO-2024-002",
        "amount": 3400.75
      }
    ]
  }
}

Build docs developers (and LLMs) love

Get started for freeTalk to us