Invoice


Table of contents

    Overview

    Invoice endpoint allows you to create GENIUS invoice to NDIA or a client. To call Invoice endpoint, use one of the URLs from the following tables:

    URL GET PUT POST DELETE
    https://api.mypcorp.com/invoice ✔ ✔
    https://api.mypcorp.com/invoice/{InvoiceGuid} ✔

    NB: Currently, the MYP API only accepts GET and POST requests. PUT and DELETE requests will be available in the future.

    GET

    The following table illustrates which fields can be included when receiving a GET response.

    NB: Nested properties are hidden by default. To expand all nested properties, add $expand=* to the URL. To expand a specific nested property, set the property name after $expand= (i.e. $expand=LineItems).

    Invoice
    Field Name Description
    InvoiceGuid
    Guid (Identifier)     		The Invoice’s id.
    InvoiceNumber
    string    		 Invoice number of the Invoice.
    ExternalInvoiceNumber
    string    		 Invoice number for a third party accounting package (i.e. Xero, MYOB).
    InvoiceClaimType
    string    		 Indicates whether this Invoice is to NDIA or client.
    Possible values are:
    “InvoiceToNdia”
    “InvoiceToClient”
    StartDate
    Date    		 Start date of the Invoice.
    EndDate
    Date    		 End date of the Invoice.
    DueDate
    Date    		 Payment due date of the Invoice.
    PaymentDateTime
    Date    		 Payment date of the Invoice.
    Total
    decimal    		 Total amount of the Invoice.
    IsRecurring
    boolean    		 Indicates whether the Invoice is recurring or not.
    RecurringStartDate
    Date    		 Start date of the Invoice recurrence.
    RecurringEndDate
    Date    		 End date of the Invoice recurrence.
    RecurringFrequency
    string    		 Indicates how frequent the Invoice is recurred.
    Possible values are:
    “Daily”
    “Weekly”
    “Fortnightly”
    “Monthly”
    “Yearly”
    Resubmitted
    boolean    		 Indicates whether the Invoice has been resubmitted or not.
    GeniusStatus
    string    		 Status of the Invoice on GENIUS.
    Possible values are:
    “AwaitingStaffApproval”
    “SubmittedToLanternPay”
    “OnHold”
    “Approved”
    “NdiaClaimed”
    “NdiaFullyPaid”
    “NdiaPartiallyPaid”
    “LanternPayCancellationRequested”
    “LanternPayCancelled”
    “LanternPayRejected”
    “ClientRejected”
    “PlanManagerRejected”
    “Sent”
    “Paid”
    CreationDate
    DateTime    		 The date the Invoice record was created.
    ApprovedDate
    DateTime    		 The date when the Invoice has been approved.
    ArchiveDate
    DateTime    		 Date when the Invoice was archived, if they have been archived.
    ClientGuid
    Guid    		 Guid of the Client that Contact of the Invoice belongs to. To view the client’s details, refer to Client endpoint.
    ContactGuid
    Guid    		 Guid of the Contact of the Invoice. To view the contact’s details, refer to Contact endpoint.
    StaffGuid
    Guid    		 Guid of the staff who is in charge of the Invoice. To view the staff’s details, refer to Staff endpoint.
    LineItems
    object    		 Breakdown of the Invoice based on a product, on information, called a LineItem object. To view the LineItem’s details, refer to the following LineItems table.
    LineItems
    Field Name Description
    LineItemGuid
    Guid (Identifier)     		The LineItem’s id.
    Notes
    string     		Notes of the LineItem.
    FromDate
    Date    		 Start date of the service/product in LineItem.
    ToDate
    Date    		 End date of the service/product in LineItem.
    Quantity
    decimal    		 Quantity of the product of LineItem.
    Price
    decimal    		 Price of the product of LineItem.
    Total
    decimal    		 Total amount of the LineItem.
    AmountPaid
    decimal    		 Amount paid for the LineItem in the past.
    IsCreditItem
    boolean     		Indicates whether the line item is a credit item or not.
    TaxChoice
    string    		 Tax rate selected for the LineItem.
    Possible values are:
    “BasExcluded”
    “GstFreeExports”
    “GstFreeIncome”
    “GstOnIncome”
    null
    ClaimType
    string    		 Claim type that indicates what LineItem claims for.
    Possible values are:
    “None”
    “Cancellation”
    “NdiaRequiredReport”
    “ProviderTravel”
    “NonFaceToFaceServices”
    “DirectService”
    “IrregularSilSupports”
    “Telehealth”
    null
    CancellationReason
    string    		 Cancel reason of the service/product of the LineItem.
    Possible values are:
    “None”
    “HealthReason”
    “FamilyIssues”
    “UnavailabilityOfTransport”
    “Other”
    null
    CreationDate
    DateTime    		 The date the LineItem record was created.
    ModifyDate
    DateTime    		 The date the LineItem record was modified.
    ArchiveDate
    DateTime    		 The date the LineItem record was archived.
    PriceBook
    object     		Price book that the product belongs to. To view the price book details, refer to PriceBook endpoint.
    Product
    object     		Product/service of the LineItem. To view the product details, refer to PriceBook endpoint.
    CostCentre
    object     		Cost centre of the LineItem. To view the cost centre details, refer to CostCentre endpoint.

    Example JSON response:

    {
  "@odata.context": "https://api.mypcorp.com/$metadata#Invoice(LineItems())",
  "value": [
    {
      "InvoiceGuid": "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
      "InvoiceNumber": "CORP-10001",
      "ExternalInvoiceNumber": null,
      "InvoiceClaimType": "InvoiceToNdia",
      "StartDate": "2021-05-05",
      "EndDate": "2021-05-06",
      "DueDate": "2021-05-31",
      "PaymentDate": null,
      "Total": 46.00,
      "IsRecurring": true,
      "RecurringStartDate": "2021-05-31",
      "RecurringEndDate": null,
      "RecurringFrequency": "Monthly",
      "Resubmitted": false,
      "GeniusStatus": "AwaitingStaffApproval",
      "CreationDate": "2021-05-07T08:40:01.813+10:00",
      "ApprovedDate": null,
      "ArchiveDate": null,
      "ClientGuid": "6ce4bd43-65fb-e911-811a-da4668ab9948",
      "ContactGuid": "74e4bd43-65fb-e911-811a-da4668ab9948",
      "StaffGuid": "3e409a43-2eee-e911-8118-e20775e306c4",
      "LineItems": [
        {
          "LineItemGuid": "d6c5b4a3-f2e1-d0c9-b8a7-f6e5d4c3b2a1",
          "Notes": "Assistance with, or supervision of, personal tasks of daily living where overnight support is needed. Provided on 05/05/2021",
          "FromDate": "2021-05-05",
          "ToDate": "2021-05-06",
          "Quantity": 1.00,
          "Price": 46.00,
          "Total": 46.00,
          "AmountPaid": null,
          "IsCreditItem": false,
          "TaxChoice": "GstFreeIncome",
          "ClaimType": "None",
          "CancellationReason": "None",
          "CreationDate": "2021-05-07T08:40:01.813+10:00",
          "ModifyDate": "2021-05-26T08:54:19.98+10:00",
          "ArchiveDate": null,
          "PriceBook": {
            "PriceBookGuid": "20a51ed2-defe-4870-9688-d999ad57f6c6",
            "Name": "General NDIS Price Book"
          },
          "Product": {
            "ProductGuid": "8911c154-e8e1-4b9f-864e-d327bbe2d0fc",
            "Code": "14_034_0127_8_3",
            "Name": "Plan Management - Financial Administration -QLD",
            "LongDescription": "A monthly fee for the ongoing maintenance of the financial management arrangements for managing of funding of supports."
          },
          "CostCentre": {
            "CostCentreGuid": "db3065e7-a029-eb11-a824-000d3acb64f7",
            "Name": "Brisbane"
        }
      ]
    }
  ]
}

    POST

    Parameter

    Parameter Name Description Required Default Value
    ignoreWarnings
    boolean    		 If set to true, warning messages in the response are ignored and the request is posted. Otherwise, the request will return warning messages with the response of 400 (Bad Request). Optional false

    Request Body

    The following table illustrates which fields can be included when sending a POST request. A number next to the data type (e.g. string (500)), is the maximum number of characters for this field. All required fields must be included in the request body to get a successful response. Dates must be set in the standard SQL datetime format, which is YYYY-MM-DD hh:mm:ss[.nnn].

    Invoice
    Field Name Description Required
    InvoiceNumber
    string (47)    		 Invoice number of the Invoice. This field must be unique. Automatically assigns InvoiceNumber from ARM settings if not provided. Optional
    InvoiceClaimTypeId
    string    		 Id of the chosen invoice type. This field must be one of the follows:
    40200 or “InvoiceToNdia”
    40300 or “InvoiceToClient”    		 Required
    StartDate
    Date    		 Start date of the Invoice. Required
    EndDate
    Date    		 End date of the Invoice. Required
    DueDate
    Date    		 Payment due date of the Invoice. Optional
    IsRecurring
    boolean    		 Indicates whether the Invoice is recurring or not. Required
    RecurringStartDate
    Date    		 Start date of the Invoice recurrence. Required for POST requests if IsRecurring property is set to true. Required (conditional)
    RecurringEndDate
    Date    		 End date of the Invoice recurrence. Optional
    RecurringFrequency
    string    		 Indicates how frequent the Invoice is recurred. Required for POST requests if IsRecurring property is set to true. This field must be one of the follows if provided:
    33950 or “Daily”
    34000 or “Weekly”
    34100 or “Fortnightly”
    34200 or “Monthly”
    34250 or “Yearly”    		 Required (conditional)
    ContactGuid
    Guid    		 Guid of the Contact of the Invoice. To view the contact’s details, refer to Contact endpoint. Required
    StaffGuid
    Guid    		 Guid of the staff who is in charge of the Invoice. View/Administer GENIUS invoice permissions required. To view the staff’s details, refer to Staff endpoint. Required
    LineItems
    object    		 Breakdown of the Invoice based on a product, called a LineItem object. Required at least one item in the list for POST requests. To view the LineItem’s details, refer to the following LineItems table. Required
    LineItems
    Field Name Description Required
    FromDate
    Date    		 Start date of the service/product in LineItem. Optional
    ToDate
    Date    		 End date of the service/product in LineItem. Optional
    Quantity
    decimal    		 Quantity of the product of LineItem. Required
    Price
    decimal    		 Price of the product of LineItem. Required for POST requests when the product price is not specified in the price book. Required (conditional)
    Notes
    string    		 Notes of the LineItem. Automatically assigns LongDescription from Product if not provided. Optional
    IsCreditItem
    boolean     		Indicates whether the line item is a credit item or not. Staff for the Invoice needs to have a permission to administer credit invoices in ARM to set this field to true. LineItem will not be a credit item if not provided. Optional
    TaxChoice
    string    		 Indicates the chosen tax rate for the LineItem. This field must be one of the follows if provided:
    34300 or “BasExcluded”
    34600 or “GstFreeExports”
    34700 or “GstFreeIncome”
    35200 or “GstOnIncome”    		 Optional
    ClaimType
    string    		 Claim type that indicates what LineItem claims for. This field must be one of the follows if provided:
    1 or “Cancellation”
    2 or “NdiaRequiredReport”
    3 or “ProviderTravel”
    4 or “NonFaceToFaceServices”
    5 or “DirectService”
    6 or “IrregularSilSupports”
    7 or “Telehealth”    		 Optional
    CancellationReason
    string    		 Cancel reason of the service/product of the LineItem. This field must be one of the follows if provided:
    1 or “HealthReason”
    2 or “FamilyIssues”
    3 or “UnavailabilityOfTransport”
    4 or “Other”    		 Optional
    PriceBook
    object     		Price book that the product belongs to. To view the price book details, refer to PriceBook endpoint. Required
    Product
    object     		Product/service of the LineItem. To view the product details, refer to PriceBook endpoint. Required
    CostCentre
    object     		Cost centre of the LineItem. To view the cost centre details, refer to CostCentre endpoint. Optional

    Example request body:

    {
  "value": [
    {
      "InvoiceNumber": "CORP-10001",
      "InvoiceClaimTypeId": 40200,
      "StartDate": "2021-05-05",
      "EndDate": "2021-05-06",
      "DueDate": "2021-05-31",
      "IsRecurring": false,
      "RecurringStartDate": null,
      "RecurringEndDate": null,
      "RecurringFrequencyId": null,
      "ContactGuid": "74e4dd53-95fb-e931-f11a-da4168ab8948",
      "StaffGuid": "3e4a9a43-2efe-e91d-c188-f20795e307c4",
      "LineItems": [
        {
          "FromDate": "2021-05-05",
          "ToDate": "2021-05-06",
          "Quantity": 1.00,
          "Price": 46.00,
          "Notes": "Assistance with, or supervision of, personal tasks of daily living where overnight support is needed. Provided on 05/05/2021",
          "IsCreditItem": false,
          "TaxChoice": 34700,
          "ClaimType": null,
          "CancellationReason": null,
          "PriceBook": {
            "PriceBookGuid": "20a51ed2-defe-4870-9688-d999ad57f6c6"
          },
          "Product": {
            "ProductGuid": "8911c154-e8e1-4b9f-864e-d327bbe2d0fc"
          },
          "CostCentre": {
            "CostCentreGuid": "db3065e7-a029-eb11-a824-000d3acb64f7"
        }
      ]
    }
  ]
}


    Previous article Next article