Use Case or Retrieving an Invoice

Use the GET command to retrieve an invoice.

          GET {{REST_SERVICES}}/record/v1/invoice/1215/ 

        

In the response body, you will get details of the requested invoice.

          {
    "links": [
        {
            "rel": "self",
            "href": "https://<accountID>.suitetalk.api.netsuite.com/services/rest/record/v1/invoice/1215/"
        }
    ],
    "amountPaid": 0.0,
    "amountRemaining": 1000.0,
    "amountRemainingTotalBox": 1000.0,
    "billAddress": "Dwight Schrute\nNew York NY 10001\nUnited States",
    "billAddressList": {
        "links": [],
        "id": "401",
        "refName": "New York HQ"
    },
    "billingAddress": {
        "links": [
            {
                "rel": "self",
                "href": "https://<accountID>.suitetalk.api.netsuite.com/services/rest/record/v1/invoice/1215/billingAddress"
            }
        ]
    },
    "billingAddress_text": "Dwight Schrute\nNew York NY 10001\nUnited States",
    "createdDate": "2023-02-06T09:48:00Z",
    "currency": {
        "links": [
            {
                "rel": "self",
                "href": "https://<accountID>.suitetalk.api.netsuite.com/services/rest/record/v1/currency/1"
            }
        ],
        "id": "1",
        "refName": "USA"
    },
    "custbody_atlas_exist_cust_hdn": {
        "links": [
            {
                "rel": "self",
                "href": "https://<accountID>.suitetalk.api.netsuite.com/services/rest/record/v1/customlist_atlas_cust_type/2"
            }
        ],
        "id": "2",
        "refName": "Existing Customer"
    },
    "custbody_atlas_new_cust_hdn": {
        "links": [
            {
                "rel": "self",
                "href": "https://<accountID>.suitetalk.api.netsuite.com/services/rest/record/v1/customlist_atlas_cust_type/1"
            }
        ],
        "id": "1",
        "refName": "New Customer"
    },
    "custbody_atlas_no_hdn": {
        "links": [
            {
                "rel": "self",
                "href": "https://<accountID>.suitetalk.api.netsuite.com/services/rest/record/v1/customlist_atlas_appr_by_creator/2"
            }
        ],
        "id": "2",
        "refName": "No"
    },
    "custbody_atlas_yes_hdn": {
        "links": [
            {
                "rel": "self",
                "href": "https://<accountID>.suitetalk.api.netsuite.com/services/rest/record/v1/customlist_atlas_appr_by_creator/1"
            }
        ],
        "id": "1",
        "refName": "Yes"
    },
    "custbody_esc_created_date": "2023-02-06",
    "custbody_esc_last_modified_date": "2023-02-06",
    "customForm": {
        "id": "91",
        "refName": "Standard Service Invoice"
    },
    "dueDate": "2023-02-21",
    "email": "another.customer@example.com",
    "entity": {
        "links": [
            {
                "rel": "self",
                "href": "https://<accountID>.suitetalk.api.netsuite.com/services/rest/record/v1/customer/614"
            }
        ],
        "id": "614",
        "refName": "8 Another Company 1661496973"
    },
    "estGrossProfit": 1000.0,
    "estGrossProfitPercent": 100.0,
    "exchangeRate": 1.0,
    "id": "1215",
    "item": {
        "links": [
            {
                "rel": "self",
                "href": "https://<accountID>.suitetalk.api.netsuite.com/services/rest/record/v1/invoice/1215/item"
            }
        ]
    },
    "lastModifiedDate": "2023-02-06T09:48:00Z",
    "location": {
        "links": [
            {
                "rel": "self",
                "href": "https://<accountID>.suitetalk.api.netsuite.com/services/rest/record/v1/location/1"
            }
        ],
        "id": "1",
        "refName": "California"
    },
    "originator": "restWebServices",
    "postingPeriod": {
        "links": [
            {
                "rel": "self",
                "href": "https://<accountID>.suitetalk.api.netsuite.com/services/rest/record/v1/accountingperiod/21"
            }
        ],
        "id": "21",
        "refName": "Feb 2023"
    },
    "prevDate": "2023-02-06",
    "salesEffectiveDate": "2023-02-06",
    "shipAddress": "Dwight Schrute\nNew York NY 10001\nUnited States",
    "shipAddressList": {
        "links": [],
        "id": "401",
        "refName": "New York HQ"
    },
    "shipDate": "2023-02-06",
    "shipIsResidential": false,
    "shipOverride": false,
    "shippingAddress": {
        "links": [
            {
                "rel": "self",
                "href": "https://<accountID>.suitetalk.api.netsuite.com/services/rest/record/v1/invoice/1215/shippingAddress"
            }
        ]
    },
    "shippingAddress_text": "Dwight Schrute\nNew York NY 10001\nUnited States",
    "source": {
        "id": "REST Web Services",
        "refName": "REST Web Services"
    },
    "status": {
        "id": "Open",
        "refName": "Open"
    },
    "subsidiary": {
        "links": [
            {
                "rel": "self",
                "href": "https://<accountID>.suitetalk.api.netsuite.com/services/rest/record/v1/subsidiary/1"
            }
        ],
        "id": "1",
        "refName": "Parent Company"
    },
    "subtotal": 1000.0,
    "terms": {
        "links": [
            {
                "rel": "self",
                "href": "https://<accountID>.suitetalk.api.netsuite.com/services/rest/record/v1/term/1"
            }
        ],
        "id": "1",
        "refName": "Net 15"
    },
    "toBeEmailed": false,
    "toBeFaxed": false,
    "toBePrinted": false,
    "total": 1000.0,
    "totalCostEstimate": 0.0,
    "tranDate": "2023-02-06",
    "tranId": "INV07"
} 

        

Related Topics

Invoice Use Cases
Use Case for Creating an Invoice
Use Cases for Updating an Invoice
Use Case for Fetching Invoices from a Lead Source
Use Case for Deleting an Invoice

General Notices