v1

latestOpenAPI 3.1.02026-08-0420819698.7 KB
Routes
Bills

Get Bills

This request gets information such as Bill IDs, Bill Numbers, etc.

This call returns a "meta" object containing URLs that can be used to get data related to the Bill.

Note: this endpoint supports pagination. Please refer to the Pagination section for more information.

Return data description

Property: meta, Description: useful links relating to this Bill Property: billID, Description: The unique ID of the Bill. Property: billNumber, Description: The bill number assigned to the Bill. Property: poID, Description: The poID of which the Bill was made. Property: locationID, Description: The unique ID of the location associated with this Bill. Property: date, Description: The date this Bill was created as a UNIX timestamp. Property: status, Description: The status of this Bill. The status can be as follows: 0: The bill is setup. 1: The bill is submitted. 2: The bill is closed i.e. Marked as Paid Property: userID, Description: The Id of the user this Bill was assigned to. Property: userIDStarted, Description: The ID of the user this Bill was created by. Property: userIDMarkPaid, Description: The ID of the user this Bill was marked paid by.

get/v2/bills

Query parameters

billsinteger

This parameter is used to only get specific Bills. This parameter expects a comma delimited list of billIDs.

numbersinteger

This parameter is used to only get specific Bills by Number. This parameter expects a comma delimited list of billNumbers.

statusstring

This parameter is used to only get specific Bills by their status. The bill status could be 0,1 or 2

endinteger

This parameter is used to only get Bills that were created before or on the unix timestamp passed into it.

limitinteger

This parameter is a result limiter. The default is set to return no more than 100 results at one time.

posinteger

This parameter is used to only get specific Bills by POs. This parameter expects a comma delimited list of PO IDs.

startinteger

This parameter is used to only get Bills that were created after or on the unix timestamp passed into it.

locationsinteger

This parameter is used to only get Bills at a specific group of Locations. This parameter accepts a comma delimited list of Location IDs.

cursorinteger

This parameter is a cursor that selects what billID you want to start receiving results at. e.g. passing 130 here will only get you bills with an id greater than 130.

pageinteger

This parameter is used to paginate results based on the limit. Refer to Pagination section for more information.

Response

Get Bills

billIDinteger
poIDinteger
statusinteger
userIDinteger
userIDStartedinteger
userIDMarkPaidinteger
billNumberinteger
locationIDinteger
dateinteger