Bill
Bills

Gets the latest bills for a business.

Request

  • Base URL
    https://api.railz.ai
  • Auth
    HTTP bearer

Query parameters

businessNamestring required
serviceName'freshbooks' | 'quickbooks' | 'quickbooksDesktop' | 'xero' | 'oracleNetsuite' | 'sageBusinessCloud' | 'sageIntacct' | 'dynamicsBusinessCentral' | 'dynamics365Finance' | 'myob' | 'zohoBooks' required
startDatestring

Transaction date greater than or equal to parameter in the format: YYYY-MM-DD.

endDatestring

Transaction date less than or equal to parameter in the format: YYYY-MM-DD.

offsetnumber

The offset is the position in the dataset of a particular record.

limitnumber
Example:100

This is the size of the results set you would like (default: 100).

orderBystring
status'open' | 'draft' | 'partiallyPaid' | 'paid' | 'unknown' | 'void'

Response

countnumber required

Example response

{
  "count": 1,
  "meta": {
    "reportId": [
      "5fad8a342a88364234392fb5",
      "5fad8a342a88364234392fb6"
    ],
    "serviceName": "xero",
    "businessName": "Railz",
    "startDate": "2020-11-25T01:02:03Z",
    "endDate": "2020-11-30T01:02:03Z",
    "createdAt": "2020-11-25T01:02:03Z",
    "updatedAt": "2020-11-30T01:02:03Z"
  },
  "data": [
    {
      "id": "1",
      "vendorRef": {
        "id": "1",
        "name": "Home Depot"
      },
      "purchaseOrderRef": {
        "id": "21"
      },
      "purchaseOrderRefs": [
        {
          "id": "21"
        }
      ],
      "postedDate": "2021-03-09T10:18:29.985Z",
      "dueDate": "2021-03-09T10:18:29.985Z",
      "currencyRef": {
        "id": "CAD",
        "name": "Canadian Dollar",
        "symbol": "USD,CAD"
      },
      "currencyRate": 1.13,
      "vendorInvoiceNumber": "INV-0028",
      "lines": [
        {
          "description": "Services rendered.",
          "unitAmount": 100.5,
          "quantity": 3,
          "taxAmount": 20.5,
          "taxRateRef": {
            "id": "1",
            "name": "HST",
            "effectiveTaxRate": 13
          },
          "inventoryRef": {
            "id": "1",
            "name": "Digital Services"
          },
          "discountPercentage": 10.5,
          "id": "8a3fdcc9-83eb-4fdd-83e0-52ec1b40b072",
          "accountRef": {
            "id": "145",
            "name": "Example account"
          },
          "trackingCategoryRef": {
            "id": "4040",
            "name": "Region",
            "option": "East",
            "optionId": "40401"
          },
          "totalAmount": 10.5,
          "customerRef": {
            "id": "124",
            "name": "Railz"
          },
          "billableStatus": "notBillable",
          "subTotal": 301.5
        }
      ],
      "subTotal": 301.5,
      "taxAmount": 20.5,
      "totalAmount": 322,
      "amountDue": 322,
      "memo": "Example bill memo.",
      "payments": [
        {
          "amount": 50.5,
          "paymentId": "50",
          "date": "2021-03-09T10:18:29.985Z"
        }
      ],
      "subsidiaryRefs": [
        {
          "id": "1",
          "name": "Railz Financial"
        }
      ],
      "locationRef": {
        "id": "52",
        "name": "United States"
      },
      "sourceModifiedDate": "2021-03-09T10:18:29.985Z"
    }
  ]
}

Changes

    • info

      api tag Bill added

    • breaking

      removed the enum value plaid from the query request parameter serviceName

    • breaking

      removed the enum value shopify from the query request parameter serviceName

    • breaking

      removed the enum value square from the query request parameter serviceName

    • breaking

      removed the enum value wave from the query request parameter serviceName

    • breaking

      the response property //// became optional for the status

    • breaking

      the response property //// became optional for the status

    • breaking

      the response property //// became optional for the status

    • breaking

      the response property //// became optional for the status

    • breaking

      the //// response's property format changed from integer to float for status

    • breaking

      the //// response's property format changed from integer to float for status

    • breaking

      the //// response's property type changed from object to no type for status

    • breaking

      the //// response's property type changed from object to no type for status

    • breaking

      the // response's property type changed from object to no type for status

    • breaking

      the // response's property type changed from object to no type for status

    • breaking

      removed the required property ///// from the response with the status

    • breaking

      removed the required property ///// from the response with the status

    • warning

      removed the optional property ///// from the response with the status

    • warning

      removed the optional property ///// from the response with the status

    • warning

      removed the optional property ///// from the response with the status

    • warning

      removed the optional property ///// from the response with the status

    • warning

      removed the optional property ///// from the response with the status

    • warning

      removed the optional property ///// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property //// from the response with the status

    • warning

      removed the optional property //// from the response with the status

    • warning

      added the new byod enum value to the / response property for the response status

    • warning

      added the new byod enum value to the / response property for the response status

    • warning

      added the new dynamics365Finance enum value to the / response property for the response status

    • warning

      added the new dynamics365Finance enum value to the / response property for the response status

    • warning

      added the new dynamicsBusinessCentral enum value to the / response property for the response status

    • warning

      added the new dynamicsBusinessCentral enum value to the / response property for the response status

    • warning

      added the new freshbooks enum value to the / response property for the response status

    • warning

      added the new freshbooks enum value to the / response property for the response status

    • warning

      added the new myob enum value to the / response property for the response status

    • warning

      added the new myob enum value to the / response property for the response status

    • warning

      added the new oracleNetsuite enum value to the / response property for the response status

    • warning

      added the new oracleNetsuite enum value to the / response property for the response status

    • warning

      added the new quickbooks enum value to the / response property for the response status

    • warning

      added the new quickbooks enum value to the / response property for the response status

    • warning

      added the new quickbooksDesktop enum value to the / response property for the response status

    • warning

      added the new quickbooksDesktop enum value to the / response property for the response status

    • warning

      added the new sageBusinessCloud enum value to the / response property for the response status

    • warning

      added the new sageBusinessCloud enum value to the / response property for the response status

    • warning

      added the new sageIntacct enum value to the / response property for the response status

    • warning

      added the new sageIntacct enum value to the / response property for the response status

    • warning

      added the new wave enum value to the / response property for the response status

    • warning

      added the new wave enum value to the / response property for the response status

    • warning

      added the new xero enum value to the / response property for the response status

    • warning

      added the new xero enum value to the / response property for the response status

    • warning

      added the new zohoBooks enum value to the / response property for the response status

    • warning

      added the new zohoBooks enum value to the / response property for the response status

    • info

      added the new enum value dynamics365Finance to the query request parameter serviceName

    • info

      added the new enum value zohoBooks to the query request parameter serviceName

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added to the // response property allOf list for the response status

    • info

      added to the // response property allOf list for the response status

    • info

      added to the // response property allOf list for the response status

    • info

      added to the // response property allOf list for the response status

    • info

      added to the //// response property allOf list for the response status

    • info

      added to the //// response property allOf list for the response status

    • info

      removed from the // response property allOf list for the response status

    • info

      removed from the // response property allOf list for the response status

    • info

      the response property //// became required for the status

    • info

      the response property //// became required for the status

    • info

      response property data/items/lines/items/subTotal deprecated

    • info

      response property data/items/lines/items/subTotal deprecated

    • info

      response property data/items/lines/items/totalAmount deprecated

    • info

      response property data/items/lines/items/totalAmount deprecated

    • info

      response property data/items/lines/items/trackingCategoryRef deprecated

    • info

      response property data/items/lines/items/trackingCategoryRef deprecated

    • info

      response property data/items/locationRef deprecated

    • info

      response property data/items/locationRef deprecated