BillingOrchard API Documentation

JSON Fields for Add and Edit

These keys go under the object field of the json string. This section describes the required field name, the data type, and the character limit for each field.
NOTE: The respective ID field for each item type is not needed when doing an Add
Note 2:The format for smalldatetime is "YYYY-MM-DD HH:MM:SS"

  1. Users
    • UserID:integer:10
    • Name:string:30
    • Department:string:15
    • Email:string:50
    • UserLogin:string:60
    • UserPassword:string:15
    • Admin:1 or 0:1
    • Support:1 or 0:1
    • Active:1 or 0:1
  2. Clients
    • ClientID:integer:10
    • ClientLogin:string:60
    • ClientPassword:string:15
    • Client:string:75
    • Email:string:60
    • Tel:string:20
    • Fax:string:20
    • Contact:string:40
    • Address:string:50
    • Address2:string:50
    • City:string:30
    • State:string:20
    • Zip:string:10
    • Country:string:30
    • LastLogin:smalldatetime:16
    • Active:1 or 0:1
    • Notes:string:1073741823
    • CustomField:string:30
    • CustomFieldValue:string:30
    • ReceiveMail:1 or 0:1
    • NextBillDate:smalldatetime:16
    • FreqUnit:string:4
    • FreqDuration:integer:10
    • AutoCharge:1 or 0:1
    • ClientCard:string:50
    • ClientExp:string:10
    • ClientCardType:string:16
    • ClientFirstName:string:30
    • ClientLastName:string:40
    • DateDeleted:smalldatetime:16
    • GST:1 or 0:1
    • PST:1 or 0:1
    • HST:1 or 0:1
    • PSTCompound:1 or 0:1
    • GSTRate:decimal:24
    • PSTRate:decimal:24
    • HSTRate:decimal:24
    • CustomFieldTwo:string:20
    • DefaultRate:decimal:24
    • BankAcctFirstName:string:30
    • BankAcctLastName:string:30
    • BankAcctRoutingNum:string:30
    • BankAcctNum:string:30
    • BankAcctHolderType:string:20
    • BankAcctType:string:20
    • AutoChargeACH:1 or 0:1
    • CustomField2:string:55
    • CustomFieldValue2:string:55
    • CustomField3:string:55
    • CustomFieldValue3:string:55
    • CustomField4:string:55
    • CustomFieldValue4:string:55
    • CellNum:string:10
  3. HourlyServices
    • ItemID:integer:10
    • Service:string:30
    • Description:string:1073741823
    • HourlyRate:decimal:24
    • Taxable:1 or 0:1
  4. Invoices
    • ClientID:integer:10
    • InvoiceDate:smalldatetime:16
    • DueDate:smalldatetime:16
    • Notes:string:1073741823
    • HowSent:string:50
    • Terms:string:1073741823
    • TotalCost:money (45.45):19
    • OutstandingAmount:money (45.45):19
    • UserID:integer:10
    • InvoiceCustom:integer:10
    • TotalTax:money (45.45):10
    • ProjectID:integer:10
    • LastChargeDate:smalldatetime:16
    • Resent:1 or 0:1
    • LastResendDate:smalldatetime:16
  5. Payments
    • PaymentID:integer:10
    • Invoice:integer:19
    • ClientID:integer:10
    • AmountPaid:decimal:24
    • PaymentDate:smalldatetime:16
    • Notes:string:1073741823
    • AmountPaidBalance:decimal:24
  6. BilledMisc
    • BMID:integer:10
    • UserID:integer:10
    • ClientID:integer:10
    • DateCompleted:smalldatetime:16
    • Qty:decimal:24
    • Title:string:50
    • Description:string:1073741823
    • Invoiced:1 or 0:1
    • InvoiceNumber:integer:19
    • Taxable:1 or 0:1
    • Rate:decimal:24
    • ProjectID:integer:10
  7. MiscItems
    • MiscID:integer:10
    • Item:string:53
    • Description:string:1073741823
    • Rate:decimal:24
    • Taxable:1 or 0:1
  8. BilledHourly
    • BHID:integer:10
    • UserID:integer:10
    • DateCompleted:smalldatetime:16
    • ClientID:integer:10
    • Service:string:50
    • Hours:decimal:24
    • Rate:decimal:24
    • Description:string:1073741823
    • Invoiced:1 or 0:1
    • InvoiceNumber:integer:19
    • Taxable:1 or 0:1
    • ProjectID:integer:10
  9. Subscribers
    • Company:string:50
    • Email:string:60
    • Tel:string:20
    • Contact:string:40
    • TrialSignupDate:smalldatetime:16
    • TrialVersion:1 or 0:1
    • Active:1 or 0:1
    • PID:string:35
    • PaidUntilDate:smalldatetime:16
  10. RecurringBilling
    • RBID:integer:10
    • UserID:integer:10
    • ClientID:integer:10
    • DateCompleted:smalldatetime:16
    • Qty:decimal:24
    • Title:string:50
    • Description:string:1073741823
    • Taxable:1 or 0:1
    • Rate:decimal:24
    • NextBillingDate:smalldatetime:16
    • FrequencyUnit:string:4
    • FrequencyDuration:integer:10
    • ProjectID:integer:10
API Documentation
JSON Fields for Add/Edit