Bills

An AP bill is a statement of charges for money owed to a vendor for goods or services. After creating a bill, you can move it along the normal Accounts Payable (AP) workflow. For example, that might mean approving the bill, creating a payment request for the bill, and paying the bill. For more information about bills, see Bill basics in the Sage Intacct Help Center.

Please be aware that this object is currently "Uncertified", signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.

List bills

get/objects/accounts-payable/bill

Returns up to 100 object references from the collection with a key, ID, and link for each bill. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned.

Permissions and other requirements
SubscriptionAccounts Payable
User typeBusiness, Employee, Project Manager, Warehouse
PermissionsList, View Bills
SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "299",
      • "id": "299",
      • "href": "/objects/accounts-payable/bill/299"
      },
    • {
      • "key": "294",
      • "id": "294",
      • "href": "/objects/accounts-payable/bill/294"
      },
    • {
      • "key": "295",
      • "id": "295",
      • "href": "/objects/accounts-payable/bill/295"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100
    }
}
Create a bill
post/objects/accounts-payable/bill
Creates a new bill. After you create a bill, it can be moved through the normal Accounts Payable workflow.



Permissions and other requirements



SubscriptionAccounts Payable


User typeBusiness


PermissionsList, View, Add Bills







SecurityOAuth2 
Request 
Request Body schema: application/json
dueDate
required
string <date> 
Due date for the bill.


 
 Example:  "2024-02-23"
createdDate
required
string <date> 
Date that the bill was created.


 
 Example:  "2024-01-23"
billNumber
string or null
Vendor-assigned identifier for the bill.
This is the vendor-assigned number provided on the bill. This number is unique and can be used to look up bill details.
You must specify a bill number when creating a bill unless document sequencing is configured, in which case the number is auto-generated.


 
 Example:  "Bill-001"
object
Vendor to which this bill is linked.


 
id
required
string
Unique identifier of the vendor.


 
 Example:  "V-00014"
key
string
System-assigned key for the vendor.


 
 Example:  "15"
object
Term details for the bill.


 
key
string or null
System-assigned key for the term.


 
 Example:  "16"
id
string or null
Name of the term.


 
 Example:  "Net 75"
referenceNumber
string or null
This is a number such as a purchase order or account number that might be useful in searches or reports. This number shows on the GL Details report and prints on the check and vendor Stubs.


 
 Example:  "INV-902852"
description
string or null
Additional information about the bill.


 
 Example:  "Annual maintenance charge"
postingDate
string <date> 
GL Posting date of the bill.


 
 Example:  "2024-01-23"
discountCutOffDate
string or null <date> 
Date after which the discount for the bill is no longer valid.


 
 Example:  "2024-02-15"
recommendedPaymentDate
string or null <date> 
Recommended payment date for the bill. If a Default bill payment date is set on the vendor record, Sage Intacct calculates the recommended payment date.\nYou can override the calculated date or, if there is no Default payment date for the vendor, provide a date when you create a bill.


 
 Example:  "2024-01-23"
isOnHold
boolean
 Default:  false
Set to true to place this bill on hold.


 
 Example:  false
isTaxInclusive
boolean
 Default:  false
Set to true if bill amounts already include taxes.


 
 Example:  false
paymentPriority
string
 Default:  "normal"
The payment priority for this bill, which enables you to easily identify and pay the most urgent bills first.


 Enum: "high" "low" "normal" "urgent"  
 Example:  "urgent"
object
 
id
string or null
Document ID of the vendor invoice.


 
 Example:  "Vendor Invoice-VI0031-doc"
key
string or null
System-assigned key to uniquely identify the contact.


 
 Example:  "416"
object
 
object
Pay-to contact information from the vendor record.


 
key
string
System-assigned key to uniquely identify the contact.


 
 Example:  "416"
id
string
Name of the contact.


 
 Example:  "Klay Vanderbilt"
object
Tax related information for the pay-to contact.


 
object
Return to contact information from the vendor record.


 
key
string
System-assigned key to uniquely identify the contact.


 
 Example:  "416"
id
string
Name of the contact.


 
 Example:  "Yusuf Pringle"
object
Currency details for this bill.


 
txnCurrency
required
string
The transaction currency to use for this bill. If this currency is different from the base currency, provide an exchange rate.


 
 Example:  "USD"
baseCurrency
string
Base currency for your company.


 
 Example:  "USD"
object
Exchange rate details used to calculate the base amount.


 
date
string or null <date> 
Exchange rate date for this transaction. Can be the current date, the date the transaction was issued, or the date the transaction will be paid.


 
 Example:  "2024-01-23"
rate
number or null
Exchange rate used to calculate the base amount from the transaction amount.


 
 Example:  1.0789
typeId
string or null
Exchange rate type used to calculate the base amount from the transaction amount.


 
 Example:  "1"
object
Tax solution details for this bill.


 
key
string or null
System-assigned key to uniquely identify the tax solution.


 
 Example:  "4"
id
string or null
Name or other unique identifier for the tax solution.


 
 Example:  "Australia GST"
showMultiLineTax
string or null
Set to true to enable multiple taxes per line.


 
 Example:  "true"
method
string or null
Tax method used in this bill.


 
 Example:  "VAT"
object
Summary details for this bill. Summaries are collections of the same types of transactions grouped together for processing.


 
key
string
System-assigned key to uniquely identify the summary.


 
 Example:  "280"
id
string
System-assigned ID for the summary.


 
 Example:  "280"
object
Payment information for the bill.


 
fullyPaidDate
string or null <date> 
Date on which the bill was fully paid.


 
 Example:  "2021-01-23"
object
Retainage information for the bill. (For Construction subscriptions only.) Retainage is a portion of the agreed-upon contract price withheld until the work is substantially complete.


 
object
Bill back template for bill back transactions.


 
key
string
System-assigned key for the bill back template.


 
 Example:  "121"
id
string
System-assigned ID for the bill back template.


 
 Example:  "121"
object
Supporting document attached to the bill.


 
key
string or null
System-assigned key for the supporting document.


 
 Example:  "18"
id
string or null
System-assigned ID for the supporting document.


 
 Example:  "18"
object
 
key
string
Location Key


 
 Example:  "1"
id
string
Location


 
 Example:  "US"
Array of objects
Line items of the bill


 
 Array 
txnAmount
required
string <decimal-precision-2> 
For multi-currency companies, provide a transaction amount, which is the amount in the transaction currency.


 
 Example:  "100.00"
required
object
General Ledger (GL) account associated with the line item.


 
hasForm1099
string
If the vendor is set up for 1099 tracking and enabled for 1009 flag override, you can set to true to enable individual line items for 1099 treatment. If false, this line item does not have associated 1099 form type and box values.


 
 Example:  "false"
object
Form 1099 information for the line item.


 
object
An alternative account to override the default GL AP account for the bill.


 
object
AP account label associated with the line item.


 
totalTxnAmount
string <decimal-precision-2> 
For tax inclusive bills, provide a total transaction amount.


 
 Example:  "100.00"
memo
string or null
Memo about the line item.


 
 Example:  "Service charges"
object
Transaction allocation template for the line item, which distributes the bill amount across specified dimensions.


 
object
Currency details for the bill.


 
object
Payment information for the line item.


 
releaseToPay
boolean or null
 Default:  false
If true, then this line item is available for the payment.


 
 Example:  true
object
 
object
Project-related information for the line item.


 
object
Asset information for the line item.


 
object
Purchasing document information for the line item.


 
Array of objects
Tax Entries of the AP bill


 
object
 
object
Header level details for the bill's line entries.


 
Responses 
201
Created


400
Bad Request


Request samples 
application/json
{
  • "billNumber": "Bill-001-06",
  • "vendor": {
    • "id": "1099 Int"
    },
  • "referenceNumber": "Ref-123",
  • "description": "bill - 001 - vendor 1099",
  • "createdDate": "2024-02-21",
  • "postingDate": "2024-02-21",
  • "discountCutOffDate": "2024-03-01",
  • "dueDate": "2024-03-08",
  • "recommendedPaymentDate": "2024-02-26",
  • "paymentPriority": "normal",
  • "isOnHold": false,
  • "currency": {
    • "baseCurrency": "USD",
    • "txnCurrency": "USD",
    • "exchangeRate": {
      • "date": "2022-02-21",
      • "typeId": "Intacct Daily Rate",
      • "rate": 1.0679
      }
    },
  • "contacts": {
    • "payTo": {
      • "id": "1099 Int"
      },
    • "returnTo": {
      • "id": "1099 Int"
      }
    },
  • "attachment": {
    • "id": "atch1"
    },
  • "isTaxInclusive": false,
  • "lines": [
    • {
      • "glAccount": {
        },
      • "txnAmount": "5",
      • "totalTxnAmount": "15.00",
      • "dimensions": {
        },
      • "memo": "bill - 001 - vendor 1099",
      • "hasForm1099": "false",
      • "project": {
        }
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "299",
    • "id": "299",
    • "href": "/objects/accounts-payable/bill/299"
    },
  • "ia::meta": {
    • "totalCount": 1
    }
}
Get a bill
get/objects/accounts-payable/bill/{key}
Returns detailed information for a specified bill.



Permissions and other requirements



SubscriptionAccounts Payable


User typeBusiness, Employee, Project Manager, Warehouse


PermissionsList, View Bills







SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the bill.


 
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "id": "60",
    • "key": "60",
    • "recordType": "pi",
    • "billNumber": "Bill-001-06",
    • "state": "posted",
    • "vendor": {
      • "id": "1099 Int",
      • "name": "1099 Int",
      • "key": "43",
      • "form1099": {
        },
      • "vendorDue": "21.36",
      • "href": "/objects/accounts-payable/vendor/43"
      },
    • "referenceNumber": "Ref-123",
    • "description": "bill - 001 - vendor 1099",
    • "purchasing": {
      • "id": "Vendor Invoice-VI0031-doc",
      • "key": "416",
      • "href": "/objects/purchasing/document/416"
      },
    • "term": {
      • "id": "NET-30",
      • "key": "3",
      • "href": "/objects/accounts-payable/term/3"
      },
    • "createdDate": "2022-02-21",
    • "audit": {
      • "createdDateTime": "2024-02-21T00:00:00Z",
      • "modifiedDateTime": "2024-03-20T08:31:41Z",
      • "createdBy": "95",
      • "modifiedBy": "95"
      },
    • "postingDate": "2024-02-21",
    • "discountCutOffDate": "2024-02-21",
    • "dueDate": "2024-03-08",
    • "paymentInformation": {
      • "fullyPaidDate": null,
      • "totalBaseAmountSelectedForPayment": "0.00",
      • "totalBaseAmountPaid": "0.00",
      • "totalTxnAmountSelectedForPayment": "0.00",
      • "totalTxnAmountPaid": "0.00"
      },
    • "recommendedPaymentDate": "2024-02-26",
    • "paymentPriority": "normal",
    • "isOnHold": false,
    • "currency": {
      • "baseCurrency": "AUD",
      • "txnCurrency": "USD",
      • "exchangeRate": {
        }
      },
    • "totalBaseAmount": "100.68",
    • "totalBaseAmountDue": "100.68",
    • "totalTxnAmount": "100.00",
    • "totalTxnAmountDue": "100.00",
    • "contacts": {
      • "payTo": {
        },
      • "returnTo": {
        }
      },
    • "billSummary": {
      • "name": "Bills: 2022/02/21 Batch",
      • "id": "37",
      • "key": "37",
      • "isSummaryOpen": "open",
      • "isSummaryPosted": "false",
      • "href": "/objects/accounts-payable/bill-summary/37"
      },
    • "recurringSchedule": {
      • "id": "20",
      • "key": "20",
      • "href": "/objects/core/schedule/20"
      },
    • "isSystemGenerated": false,
    • "dueInDays": "23",
    • "isTaxInclusive": false,
    • "taxSolution": {
      • "key": null,
      • "id": null,
      • "showMultiLineTax": null,
      • "method": null
      },
    • "retainage": {
      • "defaultPercentage": null,
      • "totalTxnAmountRetained": "0.00",
      • "totalTxnAmountReleased": "0.00",
      • "totalBaseAmountRetained": "0.00"
      },
    • "attachment": {
      • "id": "atch1",
      • "key": "6",
      • "href": "/objects/company-config/attachment/6"
      },
    • "sourceModule": "accountsPayable",
    • "entity": {
      • "key": null,
      • "id": null,
      • "name": null
      },
    • "location": {
      • "key": "1"
      },
    • "lines": [
      • {
        }
      ],
    • "href": "/objects/accounts-payable/bill/60"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Update a bill
patch/objects/accounts-payable/bill/{key}
Updates an existing bill by setting field values. Any fields not provided remain unchanged. Several factors, such as a bill's workflow state, determine whether a bill can be updated and, if so, which fields can be edited. For more information, see Edit bills in the Sage Intacct Help Center.



Permissions and other requirements



SubscriptionAccounts Payable, Purchasing


User typeBusiness


PermissionsList, View, Edit Bills







SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the bill.


 
Request Body schema: application/json
billNumber
string or null
Vendor-assigned identifier for the bill.
This is the vendor-assigned number provided on the bill. This number is unique and can be used to look up bill details.
You must specify a bill number when creating a bill unless document sequencing is configured, in which case the number is auto-generated.


 
 Example:  "Bill-001"
object
Vendor to which this bill is linked.


 
key
string
System-assigned key for the vendor.


 
 Example:  "15"
id
string
Unique identifier of the vendor.


 
 Example:  "V-00014"
object
Term details for the bill.


 
key
string or null
System-assigned key for the term.


 
 Example:  "16"
id
string or null
Name of the term.


 
 Example:  "Net 75"
referenceNumber
string or null
This is a number such as a purchase order or account number that might be useful in searches or reports. This number shows on the GL Details report and prints on the check and vendor Stubs.


 
 Example:  "INV-902852"
description
string or null
Additional information about the bill.


 
 Example:  "Annual maintenance charge"
postingDate
string <date> 
GL Posting date of the bill.


 
 Example:  "2024-01-23"
discountCutOffDate
string or null <date> 
Date after which the discount for the bill is no longer valid.


 
 Example:  "2024-02-15"
dueDate
string <date> 
Due date for the bill.


 
 Example:  "2024-02-23"
recommendedPaymentDate
string or null <date> 
Recommended payment date for the bill. If a Default bill payment date is set on the vendor record, Sage Intacct calculates the recommended payment date.\nYou can override the calculated date or, if there is no Default payment date for the vendor, provide a date when you create a bill.


 
 Example:  "2024-01-23"
createdDate
string <date> 
Date that the bill was created.


 
 Example:  "2024-01-23"
isOnHold
boolean
 Default:  false
Set to true to place this bill on hold.


 
 Example:  false
isTaxInclusive
boolean
 Default:  false
Set to true if bill amounts already include taxes.


 
 Example:  false
paymentPriority
string
 Default:  "normal"
The payment priority for this bill, which enables you to easily identify and pay the most urgent bills first.


 Enum: "high" "low" "normal" "urgent"  
 Example:  "urgent"
object
 
id
string or null
Document ID of the vendor invoice.


 
 Example:  "Vendor Invoice-VI0031-doc"
key
string or null
System-assigned key to uniquely identify the contact.


 
 Example:  "416"
object
 
object
Pay-to contact information from the vendor record.


 
key
string
System-assigned key to uniquely identify the contact.


 
 Example:  "416"
id
string
Name of the contact.


 
 Example:  "Klay Vanderbilt"
object
Tax related information for the pay-to contact.


 
object
Return to contact information from the vendor record.


 
key
string
System-assigned key to uniquely identify the contact.


 
 Example:  "416"
id
string
Name of the contact.


 
 Example:  "Yusuf Pringle"
object
Currency details for this bill.


 
baseCurrency
string
Base currency for your company.


 
 Example:  "USD"
txnCurrency
string
The transaction currency to use for this bill. If this currency is different from the base currency, provide an exchange rate.


 
 Example:  "USD"
object
Exchange rate details used to calculate the base amount.


 
date
string or null <date> 
Exchange rate date for this transaction. Can be the current date, the date the transaction was issued, or the date the transaction will be paid.


 
 Example:  "2024-01-23"
rate
number or null
Exchange rate used to calculate the base amount from the transaction amount.


 
 Example:  1.0789
typeId
string or null
Exchange rate type used to calculate the base amount from the transaction amount.


 
 Example:  "1"
object
Tax solution details for this bill.


 
key
string or null
System-assigned key to uniquely identify the tax solution.


 
 Example:  "4"
id
string or null
Name or other unique identifier for the tax solution.


 
 Example:  "Australia GST"
showMultiLineTax
string or null
Set to true to enable multiple taxes per line.


 
 Example:  "true"
method
string or null
Tax method used in this bill.


 
 Example:  "VAT"
object
Summary details for this bill. Summaries are collections of the same types of transactions grouped together for processing.


 
key
string
System-assigned key to uniquely identify the summary.


 
 Example:  "280"
id
string
System-assigned ID for the summary.


 
 Example:  "280"
object
Payment information for the bill.


 
fullyPaidDate
string or null <date> 
Date on which the bill was fully paid.


 
 Example:  "2021-01-23"
object
Retainage information for the bill. (For Construction subscriptions only.) Retainage is a portion of the agreed-upon contract price withheld until the work is substantially complete.


 
object
Bill back template for bill back transactions.


 
key
string
System-assigned key for the bill back template.


 
 Example:  "121"
id
string
System-assigned ID for the bill back template.


 
 Example:  "121"
object
Supporting document attached to the bill.


 
key
string or null
System-assigned key for the supporting document.


 
 Example:  "18"
id
string or null
System-assigned ID for the supporting document.


 
 Example:  "18"
object
 
key
string
Location Key


 
 Example:  "1"
id
string
Location


 
 Example:  "US"
Array of objects
Line items of the bill


 
 Array 
hasForm1099
string
If the vendor is set up for 1099 tracking and enabled for 1009 flag override, you can set to true to enable individual line items for 1099 treatment. If false, this line item does not have associated 1099 form type and box values.


 
 Example:  "false"
object
Form 1099 information for the line item.


 
object
General Ledger (GL) account associated with the line item.


 
object
An alternative account to override the default GL AP account for the bill.


 
object
AP account label associated with the line item.


 
txnAmount
string <decimal-precision-2> 
For multi-currency companies, provide a transaction amount, which is the amount in the transaction currency.


 
 Example:  "100.00"
totalTxnAmount
string <decimal-precision-2> 
For tax inclusive bills, provide a total transaction amount.


 
 Example:  "100.00"
memo
string or null
Memo about the line item.


 
 Example:  "Service charges"
object
Transaction allocation template for the line item, which distributes the bill amount across specified dimensions.


 
object
Currency details for the bill.


 
object
Payment information for the line item.


 
releaseToPay
boolean or null
 Default:  false
If true, then this line item is available for the payment.


 
 Example:  true
object
 
object
Project-related information for the line item.


 
object
Asset information for the line item.


 
object
Purchasing document information for the line item.


 
Array of objects
Tax Entries of the AP bill


 
object
 
object
Header level details for the bill's line entries.


 
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "billNumber": "bill10"
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "63",
    • "id": "198376",
    • "href": "/objects/accounts-payable/bill/63"
    },
  • "ia::meta": {
    • "totalCount": 1
    }
}
Delete a bill
delete/objects/accounts-payable/bill/{key}
Deletes a bill. You can only delete unpaid bills that are in a Posted, Draft, or Declined state. For partially paid bills, first cancel the payment request, which changes the bill's state to Posted. Bills in an Approved state can only be deleted if no payment has been made against them.



Permissions and other requirements



SubscriptionAccounts Payable


User typeBusiness user


PermissionsList, Delete Bills







SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the bill.


 
Responses 
204
No Content


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "ia::error": {
      • "code": "invalidRequest",
      • "message": "A POST request requires a payload",
      • "errorId": "REST-1028",
      • "additionalInfo": {
        },
      • "supportId": "Kxi78%7EZuyXBDEGVHD2UmO1phYXDQAAAAo"
      }
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 0,
    • "totalError": 1
    }
}
Query bills
post/services/core/query
Queries an object for filtered data.


SecurityOAuth2 
Request 
Request Body schema: application/json
object
string
Object type to query, in the form <application-name>/<object name>. For custom objects use platform-apps/nsp::<object-name>.


 
 Example:  "accounts-payable/bill"
fields
Array of strings
List of fields to include in the response. Can be any combination of these:


    

  • The name of a field in the object that you are querying, such as id.
    

    • 

  • The name of a field in a related object, using the form relatedObjectName.fieldName, such as vendor.id.
    

    • 

  • The result of an aggregate function run against the values in the returned objects. Use the form function:fieldName, such as min:startDate to return the earliest starting date. Valid function names are:
    

      

    • count
      • 

    • avg
      • 

    • sum
      • 

    • min
      • 

    • max
      • 

    

    • 

  • The result of an aggregate function run against the values in related objects, using the form function:relatedObjectName.fieldName, such as max:vendor.creditLimit. The same functions are supported as for object fields.
    

    • 



 
 Example:  ["key","id","max:vendor.creditLimit"]
Array of equal (object) or not equal (object) or less than (object) or (less than or equal (object)) or greater than (object) or (greater than or equal (object)) or in (object) or not in (object) or between (object) or not between (object) or contains (object) or does not contain (object) or starts with (object) or does not start with (object) or ends with (object) or does not end with (object)
Filter conditions to select the objects to return based on their field values. You use operators and conditions to build your filter, such as {"$eq":{"status":"active"}} to select objects in which status is equal to "active".


 
 Example:  [{"$eq":{"status":"active"}},{"$gt":{"totalDue":"1000"}},{"$contains":{"name":"Acme"}}]
 Array 
Any of:
Field value must be equal to this specified value.


For date fields, you can use these macro values that are relative to the current date or the asOfDate in filterParameters, if set:







    

  • today

  • currentWeek

  • currentMonth

  • currentQuarter

  • currentYear





    

  • yesterday

  • lastWeek

  • priorMonth

  • priorQuarter

  • priorYear









These are most useful for queries that you want to save and use repeatedly, such as for views or reports. Just change the asOfDate each time to retrieve the same data set for different time periods.


For example, {"eq":{"postingDate":"priorYear"}}.


object
The field name and value to be compared with object values.


 
 Example:  {"status":"active"}
filterExpression
string
 Default:  "and"
Logical operators to apply when there are multiple filter conditions. The conditions in the filters array are implicitly numbered starting at 1. Supports and, or, and grouping with parentheses.


Shortcuts:


    

  • and by itself means that all conditions must be true.
    • 

  • or by itself means that at least one condition must be true.
    • 



 
 Example:  "(1 and 2) or 3"
object

Pre-defined filter options.


 
asOfDate
string <date> 
The "as of" date to use with any relative date comparisons in filters. For example, if asOfDate is set to "2022-04-01" then priorMonth will be "03".


The current date is used if asOfDate is not set.


 
 Example:  "2022-04-01"
includeHierarchyFields
boolean
 Default:  false
Set to true to include hierarchical structure information with each object in the response.


 
 Example:  false
caseSensitiveComparison
boolean
 Default:  true
Queries are case-sensitive by default. Set to false to ignore case in a query.


 
 Example:  true
includePrivate
boolean
 Default:  false
By default, in a multi-entity company, queries from the top-level entity do not access data in private entities. Set includePrivate to true if you want to query data in private entities.


 
 Example:  false
Array of objects
Set the order of the results by specifying field names to sort by and whether they should be in ascending or descending order.


 
 Example:  [{"totalDue":"asc"},{"lastPaymentMadeDate":"desc"}]
 Array 
property name*
additional property
string
 Enum: "asc" "desc"  
start
integer
First record of the result set to include in the response.


 
 Example:  1
size
integer
Number of records to include in the response.


 
 Example:  100
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "object": "accounts-payable/bill",
  • "filters": [
    • {
      • "$eq": {
        }
      }
    ],
  • "fields": [
    • "key",
    • "id",
    • "vendor.name",
    • "totalTxnAmount"
    ],
  • "orderBy": [
    • {
      • "id": "asc"
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "226",
      • "id": "226",
      • "vendor.name": "BNG Supply",
      • "totalTxnAmount": "645.58"
      },
    • {
      • "key": "1094",
      • "id": "1094",
      • "vendor.name": "Weeserve",
      • "totalTxnAmount": "100.00"
      },
    • {
      • "key": "1225",
      • "id": "1225",
      • "vendor.name": "Acme Inc.",
      • "totalAmount": "500.00"
      },
    • {
      • "key": "1245",
      • "id": "1245",
      • "vendor.name": "Pancifico",
      • "totalAmount": "289.00"
      },
    • {
      • "key": "1267",
      • "id": "1267",
      • "vendor.name": "Dunker Giffin",
      • "totalAmount": "900.00"
      }
    ],
  • "ia::meta": {
    • "totalCount": 5,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}