View source for MYOB Endpoint: PurchasesServiceOrders

== Overview ==

The MYOB '''PurchasesServiceOrders''' [[MYOB Endpoints|endpoint]] allows you to get access to service purchase orders within MYOB.


== Fields ==

The following fields are available for the PurchasesServiceOrders endpoint.

;UID
:A [[Field Type: GUID|GUID field]] representing the internal id of this record. This field can be used to link to other endpoints.

;Number
:A [[Field Type: Text|text field]] that provides the order number.

;Date
:A [[Field Type: Date|date field]] that indicates the date of the transaction.

;SupplierInvoiceNumber
:A [[Field Type: Text|text field]] that provides the supplier invoice number.

;Supplier
:A [[Field Type: Record|record field]] that provides the [[MYOB Field: Cards| supplier]] associated with this transaction.

;ShipToAddress
:A [[Field Type: Text|text field]] that provides the complete address.

;Terms
:A [[Field Type: Record|record field]] that provides the [[MYOB Field: Terms|terms]] of this transaction.

;IsTaxInclusive
:A [[Field Type: Boolean|true/false field]] that indicates if the amounts are tax inclusive or not.

;IsReportable
:A [[Field Type: Boolean|true/false field]] that indicates if the transaction is a reportable taxable payment.
:Note this applies to Australia only.

;Lines
:A [[Field Type: Table|table field]] that provides the lines of this transaction.
:See [[#Lines Fields|Lines Fields]] for more information.

;Subtotal
:A [[Field Type: Decimal|decimal field]] that provides the total of all the lines.

;SubtotalForeign
:A [[Field Type: Decimal|decimal field]] that provides the total of all the lines for foreign currency transactions.

;Freight
:A [[Field Type: Decimal|decimal field]] that provides the freight amount for this transaction.

;FreightForeign
:A [[Field Type: Decimal|decimal field]] that provides the freight amount for this transaction for foreign currency transactions. 

;FreightTaxCode
:A [[Field Type: Record|record field]] that provides the [[MYOB Field: TaxCodes|tax code]] used for freight.

;TotalTax
:A [[Field Type: Decimal|decimal field]] that provides the total tax amount.

;TotalTaxForeign
:A [[Field Type: Decimal|decimal field]] that provides the total tax amount for foreign currency transactions. 

;TotalAmount
:A [[Field Type: Decimal|decimal field]] that provides the total amount of this transaction.

;TotalAmountForeign
:A [[Field Type: Decimal|decimal field]] that provides the total amount of this transaction for foreign currency transactions. 

;Category
:A [[Field Type: Record|record field]] that provides the [[MYOB Field: Categories| category]] associated with this transaction.

;Comment
:A [[Field Type: Text|text field]] that provides the comment for the transaction.

;ShippingMethod
:A [[Field Type: Text|text field]] that provides the shipping method for the transaction.

;PromisedDate
:A [[Field Type: Date|date field]] that provides the promised date of the transaction.

;JournalMemo
:A [[Field Type: Text|text field]] that provides the memo for the transaction.

;AppliedToDate
:A [[Field Type: Decimal|decimal field]] that provides the total amount paid on this transaction.

;AppliedToDateForeign
:A [[Field Type: Decimal|decimal field]] that provides the total amount paid on this transaction for foreign currency transactions. 

;BalanceDueAmount
:A [[Field Type: Decimal|decimal field]] that provides the outstanding balance of this transaction.

;BalanceDueAmountForeign
:A [[Field Type: Decimal|decimal field]] that provides the outstanding balance of this transaction for foreign currency transactions. 

;Status
:A [[Field Type: Text|text field]] that provides the status of this transaction.
:Possible values are:
:* '''Open''': Indicates the order has not been converted to a purchase bill.
:* '''ConvertedToBill''': Indicates the order has been converted to a purchase bill.

;LastPaymentDate
:A [[Field Type: Date|date field]] that provides the last payment date applied to the transaction.

;ForeignCurrency
:A [[Field Type: Record|record field]] that provides the [[MYOB Field: Currencies| currency]] associated with this transaction.

;CurrencyExchangeRate
:A [[Field Type: Decimal|decimal field]] that provides exchange rate for foreign currency transactions.

;RowVersion
:A [[Field Type: Row Version|row version field]].


== Lines Fields ==

The [[#Fields|Lines]] field contains the following sub-fields.

;RowID
:A [[Field Type: Integer|integer field]] representing the internal id of this row.

;Type
:A [[Field Type: Text|text field]] that indicates the type of line.
:Possible values are:
:* '''Header'''
:* '''Transaction'''
:* '''Subtotal'''

;Description
:A [[Field Type: Text|text field]] that provides the line memo for the transaction.

;Total
:A [[Field Type: Decimal|decimal field]] that provides the total amount for this line.

;TotalForeign
:A [[Field Type: Decimal|decimal field]] that provides the total amount for this line for foreign currency transactions.

;Account
:A [[Field Type: Record|record field]] that provides the [[MYOB Field: Accounts|account]] for this line.

;Job
:A [[Field Type: Record|record field]] that provides the [[MYOB Field: Jobs|job]] for this line.

;TaxCode
:A [[Field Type: Record|record field]] that provides the [[MYOB Field: TaxCodes|tax code]] for this line.

;RowVersion
:A [[Field Type: Row Version|row version field]].


== MYOB API ==

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


== Related Fields ==

:[[MYOB Field: Accounts|Accounts]] 
:[[MYOB Field: Cards|Cards]] 
:[[MYOB Field: Categories|Categories]] 
:[[MYOB Field: Jobs|Jobs]] 
:[[MYOB Field: TaxCodes|TaxCodes]] 


== Related Endpoints==

:[[MYOB Endpoint: PurchasesServiceInvoices|PurchasesServiceInvoices]]


== Related Topics ==

:[[MYOB Models]]
:[[MYOB Endpoints]]