GET /accounting/transactions/balance/open
GET/accounting/transactions/balance/open
GET /accounting/transactions/balance/open
Request
Query Parameters
id int64[]
amount string
Custom decimal range syntax. Equal: 100.50; From: [100.50;]; To: [;500.00]; Between: [100.50;500.00]. Custom decimal range syntax. Equal: 100.50; From: [100.50;]; To: [;500.00]; Between: [100.50;500.00].
payment_match_search string
only_unpaid boolean
from int32
take int32
search string
sort string[]
Responses
- 200
OK
- text/plain
- application/json
- text/json
- Schema
- Example (from schema)
Schema
Array [
]
total int64nullable
from int64nullable
take int64nullable
entities
object[]
nullable
outstanding_amount double
id int64nullable
uid uuidnullable
type stringnullable
entry_type stringnullable
no stringnullable
vendor_doc_no stringnullable
credited_doc_no stringnullable
payment_reference stringnullable
description stringnullable
date_issued datenullable
date_due datenullable
date_taxable datenullable
currency stringnullable
contact
object
id int64nullable
business_name stringnullable
display_name stringnullable
reg_no stringnullable
vat_no stringnullable
tax_no stringnullable
address
object
name stringnullable
company stringnullable
address1 stringnullable
address2 stringnullable
postal_code stringnullable
city stringnullable
region stringnullable
country stringnullable
Possible values: <= 2 characters
email stringnullable
preferred_locale stringnullable
phone stringnullable
total_amount double
amount_paid double
debit double
credit double
gl_account
object
id int64nullable
number stringnullable
name stringnullable
description stringnullable
aggregations undefined[]nullable
{
"total": 0,
"from": 0,
"take": 0,
"entities": [
{
"outstanding_amount": 0,
"id": 0,
"uid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"type": "string",
"entry_type": "string",
"no": "string",
"vendor_doc_no": "string",
"credited_doc_no": "string",
"payment_reference": "string",
"description": "string",
"date_issued": "2024-07-29",
"date_due": "2024-07-29",
"date_taxable": "2024-07-29",
"currency": "string",
"contact": {
"id": 0,
"business_name": "string",
"display_name": "string",
"reg_no": "string",
"vat_no": "string",
"tax_no": "string",
"address": {
"name": "string",
"company": "string",
"address1": "string",
"address2": "string",
"postal_code": "string",
"city": "string",
"region": "string",
"country": "string"
},
"email": "string",
"preferred_locale": "string",
"phone": "string"
},
"total_amount": 0,
"amount_paid": 0,
"debit": 0,
"credit": 0,
"gl_account": {
"id": 0,
"number": "string",
"name": "string",
"description": "string"
}
}
],
"aggregations": [
null
]
}
- Schema
- Example (from schema)
Schema
Array [
]
total int64nullable
from int64nullable
take int64nullable
entities
object[]
nullable
outstanding_amount double
id int64nullable
uid uuidnullable
type stringnullable
entry_type stringnullable
no stringnullable
vendor_doc_no stringnullable
credited_doc_no stringnullable
payment_reference stringnullable
description stringnullable
date_issued datenullable
date_due datenullable
date_taxable datenullable
currency stringnullable
contact
object
id int64nullable
business_name stringnullable
display_name stringnullable
reg_no stringnullable
vat_no stringnullable
tax_no stringnullable
address
object
name stringnullable
company stringnullable
address1 stringnullable
address2 stringnullable
postal_code stringnullable
city stringnullable
region stringnullable
country stringnullable
Possible values: <= 2 characters
email stringnullable
preferred_locale stringnullable
phone stringnullable
total_amount double
amount_paid double
debit double
credit double
gl_account
object
id int64nullable
number stringnullable
name stringnullable
description stringnullable
aggregations undefined[]nullable
{
"total": 0,
"from": 0,
"take": 0,
"entities": [
{
"outstanding_amount": 0,
"id": 0,
"uid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"type": "string",
"entry_type": "string",
"no": "string",
"vendor_doc_no": "string",
"credited_doc_no": "string",
"payment_reference": "string",
"description": "string",
"date_issued": "2024-07-29",
"date_due": "2024-07-29",
"date_taxable": "2024-07-29",
"currency": "string",
"contact": {
"id": 0,
"business_name": "string",
"display_name": "string",
"reg_no": "string",
"vat_no": "string",
"tax_no": "string",
"address": {
"name": "string",
"company": "string",
"address1": "string",
"address2": "string",
"postal_code": "string",
"city": "string",
"region": "string",
"country": "string"
},
"email": "string",
"preferred_locale": "string",
"phone": "string"
},
"total_amount": 0,
"amount_paid": 0,
"debit": 0,
"credit": 0,
"gl_account": {
"id": 0,
"number": "string",
"name": "string",
"description": "string"
}
}
],
"aggregations": [
null
]
}
- Schema
- Example (from schema)
Schema
Array [
]
total int64nullable
from int64nullable
take int64nullable
entities
object[]
nullable
outstanding_amount double
id int64nullable
uid uuidnullable
type stringnullable
entry_type stringnullable
no stringnullable
vendor_doc_no stringnullable
credited_doc_no stringnullable
payment_reference stringnullable
description stringnullable
date_issued datenullable
date_due datenullable
date_taxable datenullable
currency stringnullable
contact
object
id int64nullable
business_name stringnullable
display_name stringnullable
reg_no stringnullable
vat_no stringnullable
tax_no stringnullable
address
object
name stringnullable
company stringnullable
address1 stringnullable
address2 stringnullable
postal_code stringnullable
city stringnullable
region stringnullable
country stringnullable
Possible values: <= 2 characters
email stringnullable
preferred_locale stringnullable
phone stringnullable
total_amount double
amount_paid double
debit double
credit double
gl_account
object
id int64nullable
number stringnullable
name stringnullable
description stringnullable
aggregations undefined[]nullable
{
"total": 0,
"from": 0,
"take": 0,
"entities": [
{
"outstanding_amount": 0,
"id": 0,
"uid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"type": "string",
"entry_type": "string",
"no": "string",
"vendor_doc_no": "string",
"credited_doc_no": "string",
"payment_reference": "string",
"description": "string",
"date_issued": "2024-07-29",
"date_due": "2024-07-29",
"date_taxable": "2024-07-29",
"currency": "string",
"contact": {
"id": 0,
"business_name": "string",
"display_name": "string",
"reg_no": "string",
"vat_no": "string",
"tax_no": "string",
"address": {
"name": "string",
"company": "string",
"address1": "string",
"address2": "string",
"postal_code": "string",
"city": "string",
"region": "string",
"country": "string"
},
"email": "string",
"preferred_locale": "string",
"phone": "string"
},
"total_amount": 0,
"amount_paid": 0,
"debit": 0,
"credit": 0,
"gl_account": {
"id": 0,
"number": "string",
"name": "string",
"description": "string"
}
}
],
"aggregations": [
null
]
}
Loading...