Bill
Bills

Creates an individual bill for a business.

Request

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

Request body

Example request

{
  "connection": {
    "businessName": "Railz",
    "serviceName": "quickbooks"
  },
  "data": {
    "vendorInvoiceNumber": "254",
    "postedDate": "2021-03-29",
    "dueDate": "2021-03-29",
    "currencyRate": 1.13,
    "memo": "Example bill memo.",
    "vendorRef": "132",
    "currency": "CAD",
    "locationRef": "3",
    "subsidiaryRefs": [
      "4"
    ],
    "trackingCategoryRef": "23118",
    "lines": [
      {
        "description": "Services rendered.",
        "unitAmount": 100.5,
        "quantity": 3,
        "taxAmount": 20.5,
        "customerRef": {
          "id": "124"
        },
        "billableStatus": "notBillable",
        "accountRef": "145",
        "trackingCategoryRef": "231",
        "taxRef": "24",
        "subTotal": 301.5,
        "totalAmount": 322
      }
    ]
  }
}

Response

pushCommunicationIdstring required
requestedOnstring date-time required
status'success' | 'failed' | 'pending' required
businessNamestring required
serviceName'freshbooks' | 'quickbooks' | 'quickbooksDesktop' | 'xero' | 'oracleNetsuite' | 'sageBusinessCloud' | 'sageIntacct' | 'dynamicsBusinessCentral' | 'dynamics365Finance' | 'wave' | 'myob' | 'zohoBooks' | 'byod' required

Example response

{
  "pushCommunicationId": "60473b57f0cdd1683ca71f60",
  "requestedOn": "2021-03-09T08:15:22.035Z",
  "status": "pending",
  "businessName": "Railz",
  "serviceName": "quickbooks",
  "data": {
    "vendorInvoiceNumber": "254",
    "postedDate": "2021-03-29",
    "dueDate": "2021-03-29",
    "currencyRate": 1.13,
    "memo": "Example bill memo.",
    "vendorRef": "132",
    "currency": "CAD",
    "locationRef": "3",
    "subsidiaryRefs": [
      "4"
    ],
    "trackingCategoryRef": "23118",
    "lines": [
      {
        "description": "Services rendered.",
        "unitAmount": 100.5,
        "quantity": 3,
        "taxAmount": 20.5,
        "customerRef": {
          "id": "124"
        },
        "billableStatus": "notBillable",
        "accountRef": "145",
        "trackingCategoryRef": "231",
        "taxRef": "24",
        "subTotal": 301.5,
        "totalAmount": 322
      }
    ]
  }
}

Changes

    • info

      api tag Bill added

    • breaking

      the / request property format changed from date-time to date

    • breaking

      the / request property format changed from date-time to date

    • breaking

      the response's property format changed from uuid to no format for 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 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 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 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 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 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 zohoBooks enum value to the response property for the response status

    • info

      added the new optional request property ///

    • info

      added the new optional request property ///

    • info

      request property /// deprecated

    • info

      request property /// deprecated

    • info

      request property /// deprecated

    • info

      request property / deprecated

    • info

      request property / deprecated

    • info

      added the new byod enum value to the request property /

    • info

      added the new dynamics365Finance enum value to the request property /

    • info

      added the new zohoBooks enum value to the request property /

    • info

      the / request property format was generalized from uuid to no format

    • info

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

    • info

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

    • info

      response property data/allOf[PushBill]/lines/items/subTotal deprecated

    • info

      response property data/allOf[PushBill]/lines/items/totalAmount deprecated

    • info

      response property data/allOf[PushBill]/lines/items/trackingCategoryRef deprecated

    • info

      response property data/allOf[PushBill]/locationRef deprecated

    • info

      response property data/allOf[PushBill]/trackingCategoryRef deprecated