Skip to main content

QBO

Script: Read({Entity, QBOId })​

Description

Reads the Given Entity From QBO

FileMaker Script Folder Path​

/Modules/QBO/Public/Read({Entity, QBOId })

Parameters​

TypeNameDescriptionOptionalDefault
objectparameters
stringparameters.QBOIdthe qbo Id of the record to read
stringparameters.Entitythe name of the QBO Entity to get ie "Invoice"

Success Return​

[
  {
    "type": "object",
    "name": "qbo",
    "description": "Entity as a JSON object",
    "optional": false,
    "default": ""
  }
]

Error Return​

[
  {
    "type": "object",
    "name": "error",
    "description": "",
    "optional": false,
    "default": ""
  },
  {
    "type": "number",
    "name": "error.code",
    "description": "a LedgerLink ErrorCode",
    "optional": false,
    "default": ""
  },
  {
    "type": "string",
    "name": "error.type",
    "description": "",
    "optional": false,
    "default": ""
  }
]
Meta Data
  • Modification Count: 78
  • TimeStamp: 2020-05-25 23:36:53

Script: Send FMData To QBO ({Entity , Data})​

Description

Send the Data to QBO

FileMaker Script Folder Path​

/Modules/QBO/Public/Send FMData To QBO ({Entity , Data})

Parameters​

TypeNameDescriptionOptionalDefault
objectparams
stringparams.Entity
objectparams.Data

Success Return​

none given

Error Return​

none given

Meta Data
  • Modification Count: 48
  • TimeStamp: 2021-01-26 07:25:59

Script: Get Changed QBO Data ({Entity, ... )​

Description

Get all the changes for given entitiy since a given QBO time

FileMaker Script Folder Path​

/Modules/QBO/Public/Get Changed QBO Data ({Entity, ... )

Parameters​

TypeNameDescriptionOptionalDefault
objectoptions
stringoptions.Entitythe qbo Entity ex. Item, Invoice, Account
number[options.StartPostion= 1] the page to get
stringoptions.Sincethe timestamp✅
number[options.MaxResults= 100] the number to of records to fetch. 1000 or less
boolea[options.Inactive= false] include InActive or not

Success Return​

[
  {
    "type": "object",
    "name": "response",
    "description": "",
    "optional": false,
    "default": ""
  },
  {
    "type": "object",
    "name": "response.QueryResponse",
    "description": "",
    "optional": false,
    "default": ""
  },
  {
    "type": "array",
    "name": "response.QueryResponse.Entity",
    "description": "query results, this will actually be the name of the Entity ie Item, Invoice, etc.",
    "optional": false,
    "default": ""
  },
  {
    "type": "number",
    "name": "response.QueryResponse.startPosition",
    "description": "",
    "optional": false,
    "default": ""
  },
  {
    "type": "number",
    "name": "response.QueryResponse.maxResults",
    "description": "",
    "optional": false,
    "default": ""
  },
  {
    "type": "string",
    "name": "response.time",
    "description": "",
    "optional": false,
    "default": ""
  }
]

Error Return​

[
  {
    "type": "object",
    "name": "error",
    "description": "",
    "optional": false,
    "default": ""
  },
  {
    "type": "number",
    "name": "error.errorCode",
    "description": "",
    "optional": false,
    "default": ""
  }
]
Meta Data
  • Modification Count: 50
  • TimeStamp: 2020-05-25 23:36:54

Script: Get Count (Entity)​

Description

gets the count of an entity from QBO.

FileMaker Script Folder Path​

/Modules/QBO/Public/Get Count (Entity)

Parameters​

TypeNameDescriptionOptionalDefault
stringentity

Success Return​

[
  {
    "type": "object",
    "name": "response",
    "description": "",
    "optional": false,
    "default": ""
  },
  {
    "type": "number",
    "name": "response.errorCode",
    "description": "will be zero",
    "optional": false,
    "default": ""
  },
  {
    "type": "...",
    "name": "",
    "description": "",
    "optional": false,
    "default": ""
  }
]

Error Return​

[
  {
    "type": "object",
    "name": "error",
    "description": "",
    "optional": false,
    "default": ""
  },
  {
    "type": "number",
    "name": "error.errorCode",
    "description": "some not 0 number",
    "optional": false,
    "default": ""
  }
]
Meta Data
  • Modification Count: 40
  • TimeStamp: 2020-07-27 08:40:07

Script: test Get Count​

Description

none

FileMaker Script Folder Path​

/Modules/QBO/Public/test Get Count

Parameters​

none

Success Return​

none given

Error Return​

none given

Meta Data
  • Modification Count: 13
  • TimeStamp: 2020-07-24 13:07:12

Script: Delete QBO Entity ( {Entity, QBOId} )​

Description

Deletes a given Entity from QBO. Not all entities are deletable.

FileMaker Script Folder Path​

/Modules/QBO/Public/Delete QBO Entity ( {Entity, QBOId} )

Parameters​

TypeNameDescriptionOptionalDefault
objectparameters
stringparameters.QBOIdthe qbo Id of the record to delete
stringparameters.Entitythe name of the QBO Entity to get ie "Invoice"

Success Return​

[
  {
    "type": "object",
    "name": "result",
    "description": "",
    "optional": false,
    "default": ""
  }
]

Error Return​

[
  {
    "type": "object",
    "name": "error",
    "description": "",
    "optional": false,
    "default": ""
  },
  {
    "type": "number",
    "name": "error.code",
    "description": "a LedgerLink ErrorCode",
    "optional": false,
    "default": ""
  },
  {
    "type": "string",
    "name": "error.type",
    "description": "",
    "optional": false,
    "default": ""
  }
]
Meta Data
  • Modification Count: 37
  • TimeStamp: 2021-06-16 09:12:47

Script: Normalize Addresses On Transactions ( Data )​

Description

Normalizes the Shipping and Billing on Transactions

FileMaker Script Folder Path​

/Modules/QBO/Public/Normalize Addresses On Transactions ( Data )

Parameters​

TypeNameDescriptionOptionalDefault
objectdatathe json containing addresses
objectdata.BillAddrthe billing addresses
objectdata.ShipAddrthe shipping address
objectdata.ShipFromAddrthe shipping from address

Success Return​

none given

Error Return​

none given

Meta Data
  • Modification Count: 28
  • TimeStamp: 2020-06-05 14:15:42

Script: Normalize QBO Address (addressJSON)​

Description

Extract City, Sate, and Zip from line#, if necessary. Some records in QBO don't populate the city, state, and zip fields. This script will fix that

FileMaker Script Folder Path​

/Modules/QBO/Public/Normalize QBO Address (addressJSON)

Parameters​

TypeNameDescriptionOptionalDefault
objectaddressthe json containing addresses

Success Return​

none given

Error Return​

none given

Meta Data
  • Modification Count: 26
  • TimeStamp: 2020-06-05 14:16:36

Script: Send QBO Request​

Description

Lower level API that Makes the QBO request

FileMaker Script Folder Path​

/Modules/QBO/Public/Send QBO Request

Parameters​

TypeNameDescriptionOptionalDefault
objectrequest

Success Return​

none given

Error Return​

none given

Meta Data
  • Modification Count: 136
  • TimeStamp: 2021-04-13 06:19:09

Script: Credit Memo - Get PDF (qbo_Id)​

Description

gets the credit memo as PDF from QBO. This is the actual credit memo that is visible in the QBO Interface

FileMaker Script Folder Path​

/Modules/QBO/Public/Credit Memo - Get PDF (qbo_Id)

Parameters​

TypeNameDescriptionOptionalDefault
stringqboIdthe qbo record id

Success Return​

[
  {
    "type": "object",
    "name": "response",
    "description": "",
    "optional": false,
    "default": ""
  },
  {
    "type": "number",
    "name": "response.errorCode",
    "description": "will be zero",
    "optional": false,
    "default": ""
  },
  {
    "type": "...",
    "name": "",
    "description": "",
    "optional": false,
    "default": ""
  }
]

Error Return​

[
  {
    "type": "object",
    "name": "error",
    "description": "",
    "optional": false,
    "default": ""
  },
  {
    "type": "number",
    "name": "error.errorCode",
    "description": "some not 0 number",
    "optional": false,
    "default": ""
  }
]
Meta Data
  • Modification Count: 18
  • TimeStamp: 2020-05-25 23:36:59

Script: Invoice - Get PDF (qbo_Id)​

Description

gets the invoice as PDF from QBO. This is the actual invoice that is visible in the QBO Interface

FileMaker Script Folder Path​

/Modules/QBO/Public/Invoice - Get PDF (qbo_Id)

Parameters​

TypeNameDescriptionOptionalDefault
stringqboIdthe qbo record id

Success Return​

[
  {
    "type": "object",
    "name": "response",
    "description": "",
    "optional": false,
    "default": ""
  },
  {
    "type": "number",
    "name": "response.errorCode",
    "description": "will be zero",
    "optional": false,
    "default": ""
  },
  {
    "type": "...",
    "name": "",
    "description": "",
    "optional": false,
    "default": ""
  }
]

Error Return​

[
  {
    "type": "object",
    "name": "error",
    "description": "",
    "optional": false,
    "default": ""
  },
  {
    "type": "number",
    "name": "error.errorCode",
    "description": "some not 0 number",
    "optional": false,
    "default": ""
  }
]
Meta Data
  • Modification Count: 16
  • TimeStamp: 2020-05-25 23:36:58

Script: Invoice - Send Email {qboId, email }​

Description

Send the invoice through QBO. This is equivalent to send through the QBO Send interface.

FileMaker Script Folder Path​

/Modules/QBO/Public/Invoice - Send Email {qboId, email }

Parameters​

TypeNameDescriptionOptionalDefault
objectparams
stringparams.qboIdthe qbo_id of the invoice in qbo
stringparams.emailthe email address to use to send the email - DISABLED

Success Return​

[
  {
    "type": "object",
    "name": "response",
    "description": "",
    "optional": false,
    "default": ""
  },
  {
    "type": "number",
    "name": "response.errorCode",
    "description": "will be zero",
    "optional": false,
    "default": ""
  },
  {
    "type": "...",
    "name": "",
    "description": "",
    "optional": false,
    "default": ""
  }
]

Error Return​

[
  {
    "type": "object",
    "name": "error",
    "description": "",
    "optional": false,
    "default": ""
  },
  {
    "type": "number",
    "name": "error.errorCode",
    "description": "some not 0 number",
    "optional": false,
    "default": ""
  }
]
Meta Data
  • Modification Count: 16
  • TimeStamp: 2020-05-25 23:36:58