Difference between revisions of "MYOB Endpoint: Customers"

Jump to navigation Jump to search
no edit summary
(Created page with "== Overview == The MYOB '''Customers''' endpoint allows you to access the list of customer cards. Note, these cards are also available via the (MYOB Endpoint:...")
 
Line 87: Line 87:
The [[#Fields|BuyingDetails]] field contains the following sub-fields.
The [[#Fields|BuyingDetails]] field contains the following sub-fields.


;PurchaseLayout
;SaleLayout
:A [[Field Type: Text|text field]] stores the default layout (Item, Service, Miscellaneous or Professional) used when recording purchases.
:A [[Field Type: Text|text field]] stores the default layout used when recording purchases.
:Possible values are:
:*NoDefault
:*Item
:*Service
:*Professional
:*Miscellaneous
:*TimeBilling


;PrintedForm
;PrintedForm
:A [[Field Type: Text|text field]] stores the default templated used when printing the purchase.
:A [[Field Type: Text|text field]] stores the default templated used when printing sales.


;PuchaseOrderDelivery
;InvoiceDelivery
:A [[Field Type: Text|text field]] stores the default purchase order delivery status.
:A [[Field Type: Text|text field]] stores the default invoice delivery status.


;ExpenseAccount
;ItemPriceLevel
:A [[Field Type: Text|text field]] stores the default price level for this customer.
:Possible values are:
:*Base Selling Price
:*Level A
:*Level B
:*Level C
:*Level D
:*Level E
:*Level F
 
;IncomeAccount
:A [[Field Type: Record|record field]] that gives access to the [[MYOB Field: Accounts|account]] used for recording expenses.
:A [[Field Type: Record|record field]] that gives access to the [[MYOB Field: Accounts|account]] used for recording expenses.


;PaymentMemo
;ReceiptMemo
:A [[Field Type: Text|text field]] stores the default memo used for payments.
:A [[Field Type: Text|text field]] stores the default memo used for payments.


;PurchaseComment
;SalesPerson
:A [[Field Type: Text|text field]] stores the default comment used for purchases.
:A [[Field Type: Record|record field]] that gives access to the [[MYOB Field: Cards|sales person employee]] for this customer.


;SupplierBillingRate
;SaleComment
:A [[Field Type: Decimal|decimal field]] that gives access to the tax exclusive billing rate of the supplier.
:A [[Field Type: Text|text field]] stores the default comment used for sales.


;ShippingMethod
;ShippingMethod
:A [[Field Type: Text|text field]] stores the default shipping method used for purchases.
:A [[Field Type: Text|text field]] stores the default shipping method used for sales.
 
;IsReportable
:A [[Field Type: Boolean|true/false field]] that indicates if the supplier is setup for reportable taxable payments.
:Only applicable to '''Australia'''.
 
;CostPerHour
:A [[Field Type: Decimal|decimal field]] that gives access to the cost per hour of the supplier.


;Credit
;HourlyBillingRate
:A [[Field Type: Record|record field]] that gives access to fields used to indicate credit details.
:A [[Field Type: Decimal|decimal field]] that gives access to the tax exclusive billing rate of the customer.
:See [[#BuyingDetails.Credit Fields|BuyingDetails.Credit Fields]] for more information.


;ABN
;ABN
:A [[Field Type: Text|text field]] stores the ABN of the supplier.
:A [[Field Type: Text|text field]] stores the ABN of the customer.
:Only applicable to '''Australia'''.
:Only applicable to '''Australia'''.


;ABN
;ABN
:A [[Field Type: Text|text field]] stores the ABN branch number of the supplier.
:A [[Field Type: Text|text field]] stores the ABN branch number of the customer.
:Only applicable to '''Australia'''.
:Only applicable to '''Australia'''.
;TaxIdNumber
:A [[Field Type: Text|text field]] stores the tax id number of the supplier.


;TaxCode
;TaxCode
:A [[Field Type: Record|record field]] that gives access to the [[MYOB Field: TaxCodes|tax code]] used for recording expenses.
:A [[Field Type: Record|record field]] that gives access to the [[MYOB Field: TaxCodes|tax code]] used for recording sales.


;FreightTaxCode
;FreightTaxCode
:A [[Field Type: Record|record field]] that gives access to the [[MYOB Field: TaxCodes|freight tax code]] used for recording expenses.
:A [[Field Type: Record|record field]] that gives access to the [[MYOB Field: TaxCodes|freight tax code]] used for recording sales.


;UseSupplierTaxCode
;UseCustomersTaxCode
:A [[Field Type: Boolean|true/false field]] that indicates if the supplier is tax code is used.
:A [[Field Type: Boolean|true/false field]] that indicates if the customer tax code is used.


;Terms
;Terms
:A [[Field Type: Record|record field]] that gives access to fields used to the [[MYOB Field: Terms|payment terms]].
:A [[Field Type: Record|record field]] that gives access to fields used to the [[MYOB Field: Terms|payment terms]].


;Credit
:A [[Field Type: Record|record field]] that gives access to fields used to indicate credit details.
:See [[#SellingDetails.Credit Fields|SellingDetails.Credit Fields]] for more information.
;TaxIdNumber
:A [[Field Type: Text|text field]] stores the tax id number of the customer.


== BuyingDetails.Credit Fields Fields ==
;Memo
:A [[Field Type: Text|text field]] stores the default memo for this customer.


The [[#BuyingDetails Fields|BuyingDetails]] field contains the following sub-fields.
 
== SellingDetails.Credit Fields Fields ==
 
The [[#SellingDetails Fields|SellingDetails.Credit]] field contains the following sub-fields.


;Limit
;Limit
:A [[Field Type: Decimal|decimal field]] that gives access to the credit limit given by the supplier.
:A [[Field Type: Decimal|decimal field]] that gives access to the credit limit given by the customer.


;Available
;Available
:A [[Field Type: Decimal|decimal field]] that gives access to the credit amount available for this supplier.
:A [[Field Type: Decimal|decimal field]] that gives access to the credit amount available for this customer.


;PastDue
;PastDue
:A [[Field Type: Decimal|decimal field]] that gives access to overdue credit amount for this supplier.
:A [[Field Type: Decimal|decimal field]] that gives access to overdue credit amount for this customer.
 
;OnHold
:A [[Field Type: Boolean|true/false field]] that indicates if credit has been put on hold for this customer.




Line 189: Line 209:
== MYOB API ==
== MYOB API ==


For a detailed run through of the endpoint, you can see the [https://developer.myob.com/api/accountright/v2/contact/supplier/ MYOB API].
For a detailed run through of the endpoint, you can see the [https://developer.myob.com/api/accountright/v2/contact/customer/ MYOB API].




3,246

edits

Navigation menu