Sign in
latestOpenAPI 3.0.02026-08-10233809957.8 KB

5cdfae3fa1fa

Invoice Credit Notes

Posts an individual invoice (customer) credit note for a business.

post/invoices/creditNotes

Request body

Example request

{
  "connection": {
    "businessName": "Railz",
    "serviceName": "quickbooks"
  },
  "data": {
    "passThrough": {
      "CustomField": [
        {
          "DefinitionId": "1",
          "StringValue": "my custom value",
          "Name": "Field One"
        }
      ]
    },
    "postedDate": "2021-03-29",
    "allocatedOnDate": "2021-03-29",
    "memo": "Example memo.",
    "customerRef": "124",
    "currency": "CAD",
    "lines": [
      {
        "description": "Services rendered.",
        "memo": "Example memo.",
        "taxRef": "45",
        "accountRef": "200",
        "inventoryRef": "32"
      }
    ]
  }
}

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": {
    "passThrough": {
      "CustomField": [
        {
          "DefinitionId": "1",
          "StringValue": "my custom value",
          "Name": "Field One"
        }
      ]
    },
    "postedDate": "2021-03-29",
    "allocatedOnDate": "2021-03-29",
    "memo": "Example memo.",
    "customerRef": "124",
    "currency": "CAD",
    "lines": [
      {
        "description": "Services rendered.",
        "memo": "Example memo.",
        "taxRef": "45",
        "accountRef": "200",
        "inventoryRef": "32"
      }
    ]
  }
}