Create an invoice in Netsuite

1 min

POST

https://app.amberflo.io/integration/billing/netsuite/create-invoice

Body Parameters

bodycom.amberflo.integration.billing.netsuite.NetsuiteCreateInvoiceRequest.in
- integrationSettingspayment.payment.AccountIntegrationSettings.inrequired
  Description
  The integration setting which contains the Netsuite access token
  - accountIdstring
  - idstring
  - createdTimeInSecondsinteger<int64>
  - updatedTimeInSecondsinteger<int64>
  - typestringrequired
    Description
    Indicates the specific integration. Ex: STRIPE
  - namestringrequired
    Description
    Name for the integration settings
  - descriptionstring
    Description
    Optional description for the integration settings
  - settingsmap<string, string>required
    Description
    Settings specific to the integration
- detailedInvoicepayment.billing.detailed.DetailedCustomerProductInvoice.inrequired
  Description
  The invoice to send to Netsuite
  - invoiceUristring
  - uuidstring
  - invoiceKeypayment.billing.CustomerProductInvoiceKey.in
    - accountIdstring
    - customerIdstring
    - productIdstring
    - productPlanIdstring
    - yearinteger<int32>
    - monthinteger<int32>
    - dayinteger<int32>
  - planBillingPeriodpayment.pricing.BillingPeriod.in
    - intervalpayment.pricing.BillingPeriodInterval.in
    - intervalsCountinteger<int32>
  - planNamestring
  - invoiceStartTimeInSecondsinteger<int64>
  - invoiceEndTimeInSecondsinteger<int64>
  - gracePeriodInHoursinteger<int32>
  - productItemInvoicespayment.billing.detailed.DetailedCustomerProductItemInvoice.in[]
    - keypayment.billing.CustomerProductItemInvoiceKey.in
      - accountIdstring
      - customerIdstring
      - productIdstring
      - productPlanIdstring
      - yearinteger<int32>
      - monthinteger<int32>
      - dayinteger<int32>
      - productItemKeystring
    - productItemIdstring
    - productItemNamestring
    - meterApiNamestring
    - productPlanNamestring
    - productItemInvoiceLabelstring
    - scalarnumber
    - productItemVariantspayment.billing.detailed.DetailedProductItemVariantInvoice.in[]
      - keystring
      - itemDimensionsmap<string, string>
      - dimensionLabelstring
      - hourlyBillInfospayment.billing.detailed.DetailedItemVariantBill.in[]
        startTimeInSecondsinteger<int64>
        endTimeInSecondsinteger<int64>
        meterUnitsnumber
        pricenumber
        meteredUnitsPerTiermap<string, number>
        pricePerTiermap<string, number>
        primaryMeterUnitNamestring
        secondaryMeterUnitsPerTiermap<string, object>
        secondaryPricePerTiermap<string, object>
        priceInCreditsnumber
        priceInBaseCurrencynumber
      - totalBillpayment.billing.detailed.DetailedItemVariantBill.in
        startTimeInSecondsinteger<int64>
        endTimeInSecondsinteger<int64>
        meterUnitsnumber
        pricenumber
        meteredUnitsPerTiermap<string, number>
        pricePerTiermap<string, number>
        primaryMeterUnitNamestring
        secondaryMeterUnitsPerTiermap<string, object>
        secondaryPricePerTiermap<string, object>
        priceInCreditsnumber
        priceInBaseCurrencynumber
      - lateArrivalMetersnumber
    - totalBillpayment.billing.detailed.DetailedItemVariantBill.in
      - startTimeInSecondsinteger<int64>
      - endTimeInSecondsinteger<int64>
      - meterUnitsnumber
      - pricenumber
      - meteredUnitsPerTiermap<string, number>
      - pricePerTiermap<string, number>
      - primaryMeterUnitNamestring
      - secondaryMeterUnitsPerTiermap<string, object>
      - secondaryPricePerTiermap<string, object>
      - priceInCreditsnumber
      - priceInBaseCurrencynumber
  - appliedPromotionspayment.billing.detailed.DetailedInvoiceAppliedPromotion.in[]
    - customerAppliedPromotionIdstring
    - promotionIdstring
    - promotionNamestring
    - promotionTypepayment.pricing.promotions.attributes.PromotionType.in
    - discountnumber
    - hourlyDiscountsmap<string, number>
    - promotionAppliedTimeInSecondsinteger<int64>
    - maxDiscountPossiblenumber
    - canBeUsedForPayAsYouGoboolean
    - granularitystring
    - entityTdstring
    - dimensionsmap<string, string>
    - promotionAppliedTimeRangepayment.common.TimeRange.in
      - startTimeInSecondsinteger<int64>
      - endTimeInSecondsinteger<int64>
    - discountInCreditsnumber
    - discountInBaseCurrencynumber
    - maxDiscountInBaseCurrencynumber
  - appliedPrepaidspayment.billing.detailed.DetailedInvoiceAppliedPrepaid.in[]
    - prepaidUristring
  - productPlanFeespayment.billing.detailed.DetailedProductPlanFee.in[]
    - idstring
    - namestring
    - descriptionstring
    - costnumber
    - isOneTimeFeeboolean
    - isProratedboolean
    - prorateToDayboolean
    - discountableboolean
    - prepayableboolean
    - costInCreditsnumber
    - costInBaseCurrencynumber
  - appliedInvoiceBasedFeespayment.billing.detailed.DetailedInvoiceBasedAppliedFee.in[]
    - feeIdstring
    - feeNamestring
    - feeAmountnumber
    - feeByTimeInSecondsmap<string, number>
    - feeInCreditsnumber
    - feeInBaseCurrencynumber
  - appliedInvoiceSpendingLimitFeespayment.billing.detailed.DetailedInvoiceAppliedSpendingLimitFee.in[]
    - idstring
    - labelstring
    - feeAmountnumber
    - feeAmountInCreditsnumber
    - feeAmountInBaseCurrencynumber
  - appliedCommitmentspayment.billing.detailed.DetailedInvoiceAppliedCommitmentFee.in[]
    - commitmentIdstring
    - obligationIdstring
    - obligationNamestring
    - feeAmountnumber
    - feeInCreditsnumber
    - feeInBaseCurrencynumber
  - itemSubscriptionDetailspayment.billing.SubscriptionItemDetail.in[]
    - productItemIdstring
    - variantSubscriptionDetailspayment.billing.SubscriptionVariantDetail.in[]
      - groupInfopayment.meters.GroupInfo.in
        gimap<string, string>
      - hourlyUsagepayment.billing.SubscriptionUsage.in[]
        startTimeInSecondsinteger<int64>
        endTimeInSecondsinteger<int64>
        subscriptionUnitsnumber
        overageUnitsnumber
  - totalBillpayment.billing.ProductPlanBill.in
    - startTimeInSecondsinteger<int64>
    - endTimeInSecondsinteger<int64>
    - totalPricenumber
    - itemPricenumber
    - fixPricenumber
    - invoiceBasedFeesnumber
    - invoiceSpendingLimitFeesnumber
    - commitmentsFeesnumber
    - prepaidnumber
    - totalDiscountnumber
    - totalPriceBeforeDiscountnumber
    - totalPriceBeforePrepaidnumber
    - totalPriceBeforeCommitmentsnumber
    - totalPriceBeforeSalesTaxnumber
    - discountableFixPricenumber
    - discountableBasePricenumber
    - prepayableFixPricenumber
    - prepayableNotDiscountableFeesnumber
    - prepayableCommitmentsFeesnumber
    - totalPrepayablePricenumber
  - invoicePriceStatuspayment.billing.InvoiceStatus.in
  - creditUnitpayment.pricing.CreditUnit.in
    - idstring
    - shortNamestring
    - namestring
    - ratioToCurrencynumber
    - descriptionstring
    - activeboolean
    - lastUpdateTimeInMillisinteger<int64>
  - paymentStatuspayment.payment.PaymentStatus.in
  - paymentCreatedInSecondsinteger<int64>
  - externalSystemStatusstring
  - invoiceBillInBaseCurrencypayment.billing.ProductPlanBill.in
    - startTimeInSecondsinteger<int64>
    - endTimeInSecondsinteger<int64>
    - totalPricenumber
    - itemPricenumber
    - fixPricenumber
    - invoiceBasedFeesnumber
    - invoiceSpendingLimitFeesnumber
    - commitmentsFeesnumber
    - prepaidnumber
    - totalDiscountnumber
    - totalPriceBeforeDiscountnumber
    - totalPriceBeforePrepaidnumber
    - totalPriceBeforeCommitmentsnumber
    - totalPriceBeforeSalesTaxnumber
    - discountableFixPricenumber
    - discountableBasePricenumber
    - prepayableFixPricenumber
    - prepayableNotDiscountableFeesnumber
    - prepayableCommitmentsFeesnumber
    - totalPrepayablePricenumber
  - invoiceBillInCreditspayment.billing.ProductPlanBill.in
    - startTimeInSecondsinteger<int64>
    - endTimeInSecondsinteger<int64>
    - totalPricenumber
    - itemPricenumber
    - fixPricenumber
    - invoiceBasedFeesnumber
    - invoiceSpendingLimitFeesnumber
    - commitmentsFeesnumber
    - prepaidnumber
    - totalDiscountnumber
    - totalPriceBeforeDiscountnumber
    - totalPriceBeforePrepaidnumber
    - totalPriceBeforeCommitmentsnumber
    - totalPriceBeforeSalesTaxnumber
    - discountableFixPricenumber
    - discountableBasePricenumber
    - prepayableFixPricenumber
    - prepayableNotDiscountableFeesnumber
    - prepayableCommitmentsFeesnumber
    - totalPrepayablePricenumber
  - prepaidPriceUsedBaseCurrencynumber
  - prepaidPriceUsednumber
  - availablePrepaidLeftnumber
  - availablePrepaidLeftBaseCurrencynumber
  - prepaidUsageUsednumber
  - availablePrepaidUsageLeftnumber
  - availablePrepaidLeftInCreditsnumber
  - invoiceSalesTaxcom.amberflo.integration.tax.InvoiceSalesTax.in
    - totalTaxAmountnumber
      Description
      The total tax for all lines in this transaction
    - totalTaxableAmountnumber
      Description
      The portion of the total amount of this transaction that was taxable
    - totalExemptAmountnumber
      Description
      The amount of this transaction that was exempt
    - combinedTaxRatenumber
      Description
      The rate of taxation, as a fraction of the amount
    - hasNexusboolean
      Description
      Has nexus
    - taxCodestring
      Description
      The tax code
  - availablePayAsYouGoMoneynumber
  - availablePayAsYouGoMoneyInBaseCurrencynumber
  - availablePayAsYouGoMoneyInCreditsnumber
  - paymentCurrencyInfopayment.billing.PaymentCurrencyInfo.in
    - basePlanCurrencystring
      Example
      USD
      Description
      Currency code in ISO 4217 format.
    - paymentCurrencystring
      Example
      USD
      Description
      Currency code in ISO 4217 format.
    - exchangeRatenumber
  - paymentMethodpayment.payment.PaymentMethod.in
    - methodTypestring
    - last4string
    - brandstring
  - messagescom.amberflo.service.common.log_message.LogMessage.in[]
    - levelcom.amberflo.service.common.log_message.MessageLevel.in
    - codecom.amberflo.service.common.log_message.MessageCode.in
    - messagestring
  - invoiceStartTimestring
  - invoiceEndTimestring
  - voidedboolean
- customerDetailsmetadata.customer.client.CustomerDetails.inrequired
  Description
  The customer for the invoice
  - customerIdstring
  - customerNamestring
  - customerEmailstring
  - descriptionstring
  - lifecycleStagemetadata.customer.CustomerLifecycleStage.in
  - enabledboolean
  - testboolean
  - deactivateTimeStampinteger<int64>
  - traitsmap<string, string>
  - addressmetadata.customer.client.CustomerAddress.in
    - verifiedboolean
    - line1string
    - statestring
    - citystring
    - postalCodestring
    - countrystring
  - createTimeinteger<int64>
  - updateTimeinteger<int64>
  - deleteTimeinteger<int64>

Responses

200Successful request

com.amberflo.integration.billing.netsuite.NetsuiteCreateInvoiceResponse.out
- statusboolean
  Description
  A flag to indicate if the invoice was created successfully
- idstring
  Description
  The invoice id returned from Netsuite when succeeded
- errorMessagestring
  Description
  The error message when failed

curl

curl --request POST \
     --url https://app.amberflo.io/integration/billing/netsuite/create-invoice \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
     "integrationSettings": {
     "type": "",
     "name": "",
     "settings": ""
     },
     "detailedInvoice": {},
     "customerDetails": {}
     }'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var raw = JSON.stringify({
   "integrationSettings": {
      "type": "",
      "name": "",
      "settings": ""
   },
   "detailedInvoice": {},
   "customerDetails": {}
});

var requestOptions = {
   method: 'POST',
   headers: myHeaders,
   body: raw,
   redirect: 'follow'
};

fetch("https://app.amberflo.io/integration/billing/netsuite/create-invoice", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://app.amberflo.io/integration/billing/netsuite/create-invoice")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request.body = JSON.dump({
   "integrationSettings": {
      "type": "",
      "name": "",
      "settings": ""
   },
   "detailedInvoice": {},
   "customerDetails": {}
})

response = https.request(request)
puts response.read_body

python

import requests
import json

url = "https://app.amberflo.io/integration/billing/netsuite/create-invoice"

payload = json.dumps({
   "integrationSettings": {
      "type": "",
      "name": "",
      "settings": ""
   },
   "detailedInvoice": {},
   "customerDetails": {}
})
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

200

// Successful request
{
  "status": false,
  "id": "",
  "errorMessage": ""
}