Preview Billing Information
1 min
POST
https://api.nue.io/orders/invoices:preview
Header Parameters
- acceptstringDescriptionDefaultapplication/jsonAllowedapplication/json*/*
Body Parameters
- bodyOrderInvoicePreviewRequestrequiredDescription
- customerIdstringrequiredDescription
- billingAccountIdstringDescription
- targetDatestring<date>DescriptionFormatdate
- billingPeriodstring<Month | Quarter | Semi-Annual | Annual>DescriptionAllowedMonthQuarterSemi-AnnualAnnualPattern^(Month|Quarter|Semi-Annual|Annual|SameAsSubscriptionTerm|UseSystemDefault)$
- billCycleDaystringDescriptionPattern^([0-9]{1,2}(st|nd|rd|th) of Month|AutoSetToFirstSubscription)$
- billCycleStartMonthstringDescriptionPattern^(0[1-9]{1}|1[0-2]{1})$
- paymentTermstringDescriptionPattern^(Due Upon Receipt|Net 15|Net 30|Net 45|Net 60|[0-9]+)$
- prorationEnabledbooleanDescription
- firstInvoiceOnlybooleanDescription
- skipInvoicedItemsbooleanDescription
- salesAccountBillCycleStartMonthstringDescriptionPattern^(0[1-9]{1}|1[0-2]{1})$
- salesAccountBillCycleDaystringDescriptionPattern^([0-9]{1,2}(st|nd|rd|th) of Month|AutoSetToFirstSubscription)$
- salesAccountPaymentTermstringDescriptionPattern^(Due Upon Receipt|Net 15|Net 30|Net 45|Net 60|[0-9]+)$
- salesAccountBillingPeriodstring<Month | Quarter | Semi-Annual | Annual>DescriptionAllowedMonthQuarterSemi-AnnualAnnualPattern^(Month|Quarter|Semi-Annual|Annual|SameAsSubscriptionTerm|UseSystemDefault)$
- salesAccountProrationEnabledbooleanDescription
- billingAccountBillCycleStartMonthstringDescriptionPattern^(0[1-9]{1}|1[0-2]{1})$
- billingAccountBillCycleDaystringDescriptionPattern^([0-9]{1,2}(st|nd|rd|th) of Month|AutoSetToFirstSubscription)$
- billingAccountPaymentTermstringDescriptionPattern^(Due Upon Receipt|Net 15|Net 30|Net 45|Net 60|[0-9]+)$
- billingAccountBillingPeriodstring<Month | Quarter | Semi-Annual | Annual>DescriptionAllowedMonthQuarterSemi-AnnualAnnualPattern^(Month|Quarter|Semi-Annual|Annual|SameAsSubscriptionTerm|UseSystemDefault)$
- billingAccountProrationEnabledbooleanDescription
- ordersOrderForPreview[]Description
- idstringrequiredDescription
- customerIdstringDescription
- billingAccountIdstringDescription
- billingPeriodstring<Month | Quarter | Semi-Annual | Annual>DescriptionAllowedMonthQuarterSemi-AnnualAnnualPattern^(Month|Quarter|Semi-Annual|Annual|SameAsSubscriptionTerm|UseSystemDefault)$
- billCycleDaystringDescriptionPattern^([0-9]{1,2}(st|nd|rd|th) of Month|AutoSetToFirstSubscription)$
- billCycleStartMonthstringDescriptionPattern^(0[1-9]{1}|1[0-2]{1})$
- paymentTermstringDescriptionPattern^(Due Upon Receipt|Net 15|Net 30|Net 45|Net 60|[0-9]+)$
- salesAccountBillCycleStartMonthstringDescriptionPattern^(0[1-9]{1}|1[0-2]{1})$
- salesAccountBillCycleDaystringDescriptionPattern^([0-9]{1,2}(st|nd|rd|th) of Month|AutoSetToFirstSubscription)$
- salesAccountPaymentTermstringDescriptionPattern^(Due Upon Receipt|Net 15|Net 30|Net 45|Net 60|[0-9]+)$
- salesAccountBillingPeriodstring<Month | Quarter | Semi-Annual | Annual>DescriptionAllowedMonthQuarterSemi-AnnualAnnualPattern^(Month|Quarter|Semi-Annual|Annual|SameAsSubscriptionTerm|UseSystemDefault)$
- salesAccountProrationEnabledbooleanDescription
- salesAccountSubscriptionCreatedbooleanDescription
- billingAccountBillCycleStartMonthstringDescriptionPattern^(0[1-9]{1}|1[0-2]{1})$
- billingAccountBillCycleDaystringDescriptionPattern^([0-9]{1,2}(st|nd|rd|th) of Month|AutoSetToFirstSubscription)$
- billingAccountPaymentTermstringDescriptionPattern^(Due Upon Receipt|Net 15|Net 30|Net 45|Net 60|[0-9]+)$
- billingAccountBillingPeriodstring<Month | Quarter | Semi-Annual | Annual>DescriptionAllowedMonthQuarterSemi-AnnualAnnualPattern^(Month|Quarter|Semi-Annual|Annual|SameAsSubscriptionTerm|UseSystemDefault)$
- billingAccountProrationEnabledbooleanDescription
- billingAccountSubscriptionCreatedbooleanDescription
- orderProductsOrderProductForPreview[]requiredDescription
- idstringrequiredDescription
- customerIdstringDescription
- billingAccountIdstringDescription
- orderIdstringDescription
- orderProductNumberstringDescription
- priceBookEntryIdstringDescription
- subscriptionTermnumberDescription
- summaryLineItemIdstringDescription
- uomIdstringDescription
- evergreenbooleanDescription
- descriptionstringDescription
- priceModelstringrequiredDescriptionPattern^(OneTime|Recurring|Usage|CRBD)$
- startDatestring<date>requiredDescriptionFormatdate
- endDatestring<date>DescriptionFormatdate
- totalPricenumberrequiredDescription
- totalAmountnumberDescription
- taxnumberrequiredDescription
- quantitynumberrequiredDescription
- productIdstringrequiredDescription
- productNamestringrequiredDescription
- lineTypestring<LineItem | RampItem | SummaryItem | SplitItem>requiredDescriptionAllowedLineItemRampItemSummaryItemSplitItem
- netSalesPricenumberrequiredDescription
- billingTimingstringDescription
- billingPeriodstring<Month | Quarter | Semi-Annual | Annual>DescriptionAllowedMonthQuarterSemi-AnnualAnnualPattern^(Month|Quarter|Semi-Annual|Annual|SameAsSubscriptionTerm|UseSystemDefault)$
- billCycleDaystringDescriptionPattern^([0-9]{1,2}(st|nd|rd|th) of Month|AutoSetToFirstSubscription)$
- billCycleStartMonthstringDescriptionPattern^(0[1-9]{1}|1[0-2]{1})$
- paymentTermstringDescriptionPattern^(Due Upon Receipt|Net 15|Net 30|Net 45|Net 60|[0-9]+)$
- uomExstringDescription
- currencyIsoCodestringDescription
- entityIdstringDescription
- assetTypestring<Subscription | Asset | Entitlement>DescriptionAllowedSubscriptionAssetEntitlement
- productSkustringrequiredDescription
- changeboolean
Responses
200
- Invoice[]Description
- accountExstring
- accountIdstring
- accountingStatusstring<NotStarted | Complete | Error | Skipped>AllowedNotStartedCompleteErrorSkipped
- activatedByIdstring
- activatedTimestring<date-time>Formatdate-time
- amountnumber
- amountWithoutTaxnumber
- autoNumberFormatstring
- autoNumberSequenceinteger<int64>Formatint64
- balancenumber
- billToContactExstring
- billToContactIdstring
- cancellationDatestring<date>Formatdate
- currencyIsoCodestring
- dueDatestring<date>Formatdate
- einvoicingDocIdstring<uuid>Formatuuid
- einvoicingDocStatusstring<Submitted | Accepted | Pending | Error | Complete>AllowedSubmittedAcceptedPendingErrorComplete
- einvoicingMandateCodestring
- einvoicingMandateIdstring<uuid>Formatuuid
- einvoicingMessagestring
- endDatestring<date>Formatdate
- entityIdstring
- externalInvoiceIdstring
- externalTaxIdstring
- groupKeymap<string, string>required
- emptyboolean
- idstring<uuid>Formatuuid
- invoiceDatestring<date>Formatdate
- invoiceNumberstring
- invoicePdfstring
- isCatchUpboolean
- itemsInvoiceItem[]
- tenantIdstring<uuid>Formatuuid
- accountIdstring
- groupKeymap<string, string>
- emptyboolean
- invoiceIdstring<uuid>Formatuuid
- invoiceNumberstring
- idstring<uuid>Formatuuid
- recordTypestring<Invoice | CreditMemo>AllowedInvoiceCreditMemo
- isCatchUpboolean
- invoiceItemNumberstring
- productIdstring
- productNamestring
- assetIdstring
- assetNumberstring
- assetTypestring<Subscription | Asset | Entitlement>AllowedSubscriptionAssetEntitlement
- uomIdstring
- uomExstring
- currencyIsoCodestring
- transactionDatestring<date>Formatdate
- transactionAmountnumber
- transactionAmountWithoutTaxnumber
- transactionQuantitynumber
- shippingAndHandlingnumber
- taxAmountnumber
- ratedCreditsnumber
- appliedCreditsnumber
- netSalesPricenumber
- balancenumber
- startDatestring<date>Formatdate
- endDatestring<date>Formatdate
- billingTimingstring<InAdvance | InArrears>AllowedInAdvanceInArrears
- statusstring<Draft | PendingActivation | Active | Canceled | EInvoicing>AllowedDraftPendingActivationActiveCanceledEInvoicing
- taxStatusstring<NotCalculated | Calculated | Error | Committed>AllowedNotCalculatedCalculatedErrorCommitted
- salesAccountIdstring
- detailsInvoiceItemDetail[]
- tenantIdstring<uuid>Formatuuid
- accountIdstring
- invoiceIdstring<uuid>Formatuuid
- invoiceItemIdstring<uuid>Formatuuid
- idstring<uuid>Formatuuid
- isCatchUpboolean
- orderProductIdstring
- detailTypestring<Committed | Overage>AllowedCommittedOverage
- billedAmountnumber
- transactionAmountnumber
- transactionAmountWithoutTaxnumber
- transactionQuantitynumber
- shippingAndHandlingnumber
- billedShippingnumber
- taxAmountnumber
- netSalesPricenumber
- ratedCreditsnumber
- appliedCreditsnumber
- startDatestring<date>Formatdate
- endDatestring<date>Formatdate
- billingTimingstring<InAdvance | InArrears>AllowedInAdvanceInArrears
- statusstring<Draft | PendingActivation | Active | Canceled | EInvoicing>AllowedDraftPendingActivationActiveCanceledEInvoicing
- taxStatusstring<NotCalculated | Calculated | Error | Committed>AllowedNotCalculatedCalculatedErrorCommitted
- currencyIsoCodestring
- salesAccountIdstring
- invoiceItemDetailNumberstring
- taxRatesstring
- vatCodestring
- vatNumberTypeIdstring
- avtUserBINstring
- autoNumberFormatstring
- autoNumberSequenceinteger<int64>Formatint64
- entityIdstring
- taxCodestring
- taxModestring
- taxRatesstring
- taxPercentnumber
- descriptionstring
- autoNumberFormatstring
- autoNumberSequenceinteger<int64>Formatint64
- entityIdstring
- targetDatestring<date>Formatdate
- customFieldsmap<string, object>
- paymentStatusstring<NotTransferred | Transferred | TransferError | Paid | PartialPaid | Canceled | Refunded | PartialRefunded | CreditBack | Applied | PartiallyApplied | WrittenOff | PartiallyWrittenOff | Processing>AllowedNotTransferredTransferredTransferErrorPaidPartialPaidCanceledRefundedPartialRefundedCreditBackAppliedPartiallyAppliedWrittenOffPartiallyWrittenOffProcessing
- paymentMethodsstring[]
- poDatesstring
- poNumbersstring
- recordTypestring<Invoice | CreditMemo>AllowedInvoiceCreditMemo
- salesAccountIdstring
- shippingAndHandlingnumber
- sourcestring<Billing | CreditConversion | PaymentOperation | Standalone | GenerateFromTransaction>AllowedBillingCreditConversionPaymentOperationStandaloneGenerateFromTransaction
- startDatestring<date>Formatdate
- statusstring<Draft | PendingActivation | Active | Canceled | EInvoicing>AllowedDraftPendingActivationActiveCanceledEInvoicing
- syncTimestring<date-time>Formatdate-time
- targetDatestring<date>Formatdate
- taxAmountnumber
- taxCompanyCodestring
- taxErrorMessagestring
- taxStatusstring<NotCalculated | Calculated | Error | Committed>AllowedNotCalculatedCalculatedErrorCommitted
- templateIdstring
- tenantIdstring<uuid>Formatuuid
- vatMessagesstring
400
- object
- titlestring
- messagestring
- errorCodestring
404
curl
curl --request POST \
--url https://api.nue.io/orders/invoices:preview \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--data '{
"customerId": "",
"orders": [
{
"id": ""
}
],
"orderProducts": [
{
"id": "",
"priceModel": "",
"startDate": "",
"totalPrice": "",
"tax": "",
"quantity": "",
"productId": "",
"productName": "",
"lineType": "",
"netSalesPrice": "",
"productSku": ""
}
]
}'javascript
var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
var raw = JSON.stringify({
"customerId": "",
"orders": [
{
"id": ""
}
],
"orderProducts": [
{
"id": "",
"priceModel": "",
"startDate": "",
"totalPrice": "",
"tax": "",
"quantity": "",
"productId": "",
"productName": "",
"lineType": "",
"netSalesPrice": "",
"productSku": ""
}
]
});
var requestOptions = {
method: 'POST',
headers: myHeaders,
body: raw,
redirect: 'follow'
};
fetch("https://api.nue.io/orders/invoices:preview", 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://api.nue.io/orders/invoices:preview")
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({
"customerId": "",
"orders": [
{
"id": ""
}
],
"orderProducts": [
{
"id": "",
"priceModel": "",
"startDate": "",
"totalPrice": "",
"tax": "",
"quantity": "",
"productId": "",
"productName": "",
"lineType": "",
"netSalesPrice": "",
"productSku": ""
}
]
})
response = https.request(request)
puts response.read_body
python
import requests
import json
url = "https://api.nue.io/orders/invoices:preview"
payload = json.dumps({
"customerId": "",
"orders": [
{
"id": ""
}
],
"orderProducts": [
{
"id": "",
"priceModel": "",
"startDate": "",
"totalPrice": "",
"tax": "",
"quantity": "",
"productId": "",
"productName": "",
"lineType": "",
"netSalesPrice": "",
"productSku": ""
}
]
})
headers = {
'accept': 'application/json',
'content-type': 'application/json'
}
response = requests.request("POST", url, headers=headers, data=payload)
print(response.text)
200
// Successfully generated preview invoices
[
{
"accountEx": "",
"accountId": "",
"accountingStatus": "",
"activatedById": "",
"activatedTime": "",
"amount": 0,
"amountWithoutTax": 0,
"autoNumberFormat": "",
"autoNumberSequence": "",
"balance": 0,
"billToContactEx": "",
"billToContactId": "",
"cancellationDate": "",
"currencyIsoCode": "",
"dueDate": "",
"einvoicingDocId": "",
"einvoicingDocStatus": "",
"einvoicingMandateCode": "",
"einvoicingMandateId": "",
"einvoicingMessage": "",
"endDate": "",
"entityId": "",
"externalInvoiceId": "",
"externalTaxId": "",
"groupKey": "",
"id": "",
"invoiceDate": "",
"invoiceNumber": "",
"invoicePdf": "",
"isCatchUp": false,
"items": [
{
"tenantId": "",
"accountId": "",
"groupKey": "",
"invoiceId": "",
"invoiceNumber": "",
"id": "",
"recordType": "",
"isCatchUp": false,
"invoiceItemNumber": "",
"productId": "",
"productName": "",
"assetId": "",
"assetNumber": "",
"assetType": "",
"uomId": "",
"uomEx": "",
"currencyIsoCode": "",
"transactionDate": "",
"transactionAmount": 0,
"transactionAmountWithoutTax": 0,
"transactionQuantity": 0,
"shippingAndHandling": 0,
"taxAmount": 0,
"ratedCredits": 0,
"appliedCredits": 0,
"netSalesPrice": 0,
"balance": 0,
"startDate": "",
"endDate": "",
"billingTiming": "",
"status": "",
"taxStatus": "",
"salesAccountId": "",
"details": [
{
"tenantId": "",
"accountId": "",
"invoiceId": "",
"invoiceItemId": "",
"id": "",
"isCatchUp": false,
"orderProductId": "",
"detailType": "",
"billedAmount": 0,
"transactionAmount": 0,
"transactionAmountWithoutTax": 0,
"transactionQuantity": 0,
"shippingAndHandling": 0,
"billedShipping": 0,
"taxAmount": 0,
"netSalesPrice": 0,
"ratedCredits": 0,
"appliedCredits": 0,
"startDate": "",
"endDate": "",
"billingTiming": "",
"status": "",
"taxStatus": "",
"currencyIsoCode": "",
"salesAccountId": "",
"invoiceItemDetailNumber": "",
"taxRates": "",
"vatCode": "",
"vatNumberTypeId": "",
"avtUserBIN": "",
"autoNumberFormat": "",
"autoNumberSequence": "",
"entityId": ""
}
],
"taxCode": "",
"taxMode": "",
"taxRates": "",
"taxPercent": 0,
"description": "",
"autoNumberFormat": "",
"autoNumberSequence": "",
"entityId": "",
"targetDate": "",
"customFields": "",
"paymentStatus": ""
}
],
"paymentMethods": [
""
],
"poDates": "",
"poNumbers": "",
"recordType": "",
"salesAccountId": "",
"shippingAndHandling": 0,
"source": "",
"startDate": "",
"status": "",
"syncTime": "",
"targetDate": "",
"taxAmount": 0,
"taxCompanyCode": "",
"taxErrorMessage": "",
"taxStatus": "",
"templateId": "",
"tenantId": "",
"vatMessages": ""
}
]GENERATED
// Successfully generated preview invoices
[
{
"accountEx": "",
"accountId": "",
"accountingStatus": "",
"activatedById": "",
"activatedTime": "",
"amount": 0,
"amountWithoutTax": 0,
"autoNumberFormat": "",
"autoNumberSequence": "",
"balance": 0,
"billToContactEx": "",
"billToContactId": "",
"cancellationDate": "",
"currencyIsoCode": "",
"dueDate": "",
"einvoicingDocId": "",
"einvoicingDocStatus": "",
"einvoicingMandateCode": "",
"einvoicingMandateId": "",
"einvoicingMessage": "",
"endDate": "",
"entityId": "",
"externalInvoiceId": "",
"externalTaxId": "",
"groupKey": "",
"id": "",
"invoiceDate": "",
"invoiceNumber": "",
"invoicePdf": "",
"isCatchUp": false,
"items": [
{
"tenantId": "",
"accountId": "",
"groupKey": "",
"invoiceId": "",
"invoiceNumber": "",
"id": "",
"recordType": "",
"isCatchUp": false,
"invoiceItemNumber": "",
"productId": "",
"productName": "",
"assetId": "",
"assetNumber": "",
"assetType": "",
"uomId": "",
"uomEx": "",
"currencyIsoCode": "",
"transactionDate": "",
"transactionAmount": 0,
"transactionAmountWithoutTax": 0,
"transactionQuantity": 0,
"shippingAndHandling": 0,
"taxAmount": 0,
"ratedCredits": 0,
"appliedCredits": 0,
"netSalesPrice": 0,
"balance": 0,
"startDate": "",
"endDate": "",
"billingTiming": "",
"status": "",
"taxStatus": "",
"salesAccountId": "",
"details": [
{
"tenantId": "",
"accountId": "",
"invoiceId": "",
"invoiceItemId": "",
"id": "",
"isCatchUp": false,
"orderProductId": "",
"detailType": "",
"billedAmount": 0,
"transactionAmount": 0,
"transactionAmountWithoutTax": 0,
"transactionQuantity": 0,
"shippingAndHandling": 0,
"billedShipping": 0,
"taxAmount": 0,
"netSalesPrice": 0,
"ratedCredits": 0,
"appliedCredits": 0,
"startDate": "",
"endDate": "",
"billingTiming": "",
"status": "",
"taxStatus": "",
"currencyIsoCode": "",
"salesAccountId": "",
"invoiceItemDetailNumber": "",
"taxRates": "",
"vatCode": "",
"vatNumberTypeId": "",
"avtUserBIN": "",
"autoNumberFormat": "",
"autoNumberSequence": "",
"entityId": ""
}
],
"taxCode": "",
"taxMode": "",
"taxRates": "",
"taxPercent": 0,
"description": "",
"autoNumberFormat": "",
"autoNumberSequence": "",
"entityId": "",
"targetDate": "",
"customFields": "",
"paymentStatus": ""
}
],
"paymentMethods": [
""
],
"poDates": "",
"poNumbers": "",
"recordType": "",
"salesAccountId": "",
"shippingAndHandling": 0,
"source": "",
"startDate": "",
"status": "",
"syncTime": "",
"targetDate": "",
"taxAmount": 0,
"taxCompanyCode": "",
"taxErrorMessage": "",
"taxStatus": "",
"templateId": "",
"tenantId": "",
"vatMessages": ""
}
]Invoice preview response sample
[
{
"accountId": "0018G00000WpYFiQAN",
"status": "Draft",
"accountingStatus": "NotStarted",
"recordType": "Invoice",
"amount": 8.25,
"amountWithoutTax": 8.25,
"taxAmount": 0,
"taxStatus": "NotCalculated",
"balance": 8.25,
"invoiceDate": "2023-10-25",
"dueDate": "2023-11-24",
"startDate": "2023-10-06",
"endDate": "2023-11-01",
"targetDate": "2023-10-09",
"items": [
{
"accountId": "0018G00000WpYFiQAN",
"recordType": "Invoice",
"productId": "01t8G000002Rf6gQAC",
"productName": "Nue Platform",
"assetId": "01t8G000002Rf6gQAC_preview",
"transactionDate": "2023-10-25",
"transactionAmount": 8.25,
"transactionAmountWithoutTax": 8.25,
"transactionQuantity": 1,
"taxAmount": 0,
"ratedCredits": 0,
"appliedCredits": 0,
"netSalesPrice": 8.25,
"balance": 8.25,
"startDate": "2023-10-06",
"endDate": "2023-11-01",
"billingTiming": "InAdvance",
"status": "Draft",
"taxStatus": "NotCalculated",
"details": [
{
"accountId": "0018G00000WpYFiQAN",
"orderProductId": "8028G000001KXtcQAG",
"detailType": "Committed",
"billedAmount": 8.25,
"transactionAmount": 8.25,
"transactionAmountWithoutTax": 8.25,
"transactionQuantity": 1,
"taxAmount": 0,
"ratedCredits": 0,
"appliedCredits": 0,
"startDate": "2023-10-06",
"endDate": "2023-11-01",
"billingTiming": "InAdvance",
"status": "Draft",
"taxStatus": "NotCalculated"
}
],
"priceModel": "Recurring"
}
]
}
]400
// Bad Request
{
"title": "",
"message": "",
"errorCode": ""
}404
// Not Found