MYOB Endpoint: CreditSettlements
Jump to navigation
Jump to search
Overview
The MYOB CreditSettlements endpoint allows you to get access to settled credits transaction within MYOB.
Fields
The following fields are available for the CreditSettlements endpoint.
- UID
- A GUID field representing the internal id of this record. This field can be used to link to other endpoints.
- CreditFromInvoice
- A record field that provides the invoice or order from which the credit amount comes.
- Customer
- A record field that provides the customer associated with this transaction.
- Number
- A text field that provides the transaction number.
- Date
- A date field that indicates the date of the transaction.
- CreditAmount
- A decimal field that provides the total amount settled.
- Memo
- A text field that provides the memo for the transaction.
- Lines
- A table field that provides the invoices settled.
- See Lines Fields for more information.
- ForeignCurrency
- A record field that provides the currency associated with this transaction.
- RowVersion
- A row version field.
CreditFromInvoice Fields
The CreditFromInvoice field provides access to the invoice from which the credit amount comes.
- UID
- A GUID field representing the internal id of the source invoice or order. This field can be used to link to other endpoints.
- Number
- A text field that provides the sales invoice number or sales order number.
Lines Fields
The Lines field contains the following sub-fields.
- Type
- A text field that indicates if the line applies to an invoice or order.
- Possible values are:
- Invoice for sales invoices.
- Order for sales orders.
- Sale
- A record field that provides the invoice or order on which the credit is applied.
- AmountApplied
- A decimal field that provides the total payment amount applied to this invoice and line.
Lines.Sale Fields
The Lines.Sale field provides access to the invoice or order on which the credit is applied.
- UID
- A GUID field representing the internal id of the invoice or order on which the credit is applied. This field can be used to link to other endpoints.
- Number
- A text field that provides the sales invoice number or sales order number.
MYOB API
For a detailed run through of the endpoint, you can see the MYOB API.
Related Fields