Sign in
latestOpenAPI 3.0.02026-08-10233809957.8 KB

5cdfae3fa1fa

Bill Credit Notes

Posts an individual bill (vendor) credit note for a business.

post/bills/creditNotes

Request body

Example request

{
  "connection": {
    "businessName": "Railz",
    "serviceName": "quickbooks"
  },
  "data": {
    "currencyRate": 1.13,
    "postedDate": "2021-03-29",
    "allocatedOnDate": "2021-03-29",
    "memo": "Example memo.",
    "vendorRef": "124",
    "currency": "CAD",
    "lines": [
      {
        "description": "Services rendered.",
        "unitAmount": 100.5,
        "quantity": 3,
        "billableStatus": "notBillable",
        "taxAmount": 20.5,
        "taxRef": "24",
        "accountRef": "200",
        "subTotal": 301.5,
        "totalAmount": 322,
        "customerRef": {
          "id": "124"
        }
      }
    ]
  }
}

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": {
    "currencyRate": 1.13,
    "postedDate": "2021-03-29",
    "allocatedOnDate": "2021-03-29",
    "memo": "Example memo.",
    "vendorRef": "124",
    "currency": "CAD",
    "lines": [
      {
        "description": "Services rendered.",
        "unitAmount": 100.5,
        "quantity": 3,
        "billableStatus": "notBillable",
        "taxAmount": 20.5,
        "taxRef": "24",
        "accountRef": "200",
        "subTotal": 301.5,
        "totalAmount": 322,
        "customerRef": {
          "id": "124"
        }
      }
    ]
  }
}