Send Invoice

With this API endpoint, you can export orders to Front Payment Go and get ~~payment~~Order ~~URLs~~Uuid and Customer Uuid in return.

Endpoint

POST

API

returns a

~~Endpoint~~ : https://demo-api.frontpayment.no/api/v1/connect/orders/invoice/create

~~Method~~ : ~~POST~~

~~Authorization~~ : ~~Bearer~~

~~Payload Validations~~

'products.*.name' => 'required|string',
'products.*.productId' => 'nullable|string',
'products.*.quantity' => 'required|numeric',
'products.*.rate' => 'required|numeric',
'products.*.discount' => 'nullable|numeric',
'products.*.tax' => 'required|numeric',
'products.*.amount' => 'required|numeric',
'orderSummary.subTotal' => 'required|numeric',
'orderSummary.totalTax' => 'required|numeric',
'orderSummary.totalDiscount' => 'required|numeric',
'orderSummary.grandTotal' => 'required|numeric',
'orderDate' => 'required|string',
'dueDateForPaymentLink' => 'required_if:invoiceInterval,0|string',
'sendOrderBy.sms' => 'required|boolean',
'sendOrderBy.email' => 'required|boolean',
'sendOrderBy.invoice' => 'required|boolean',
'isCreditCheckAvailable' => 'required|boolean',
'invoiceAsPaymentOption' => 'required|boolean',
'customerDetails.customerUuid' => 'nullable|string',
'customerDetails.type' => 'required|nullable|string|in:private,corporate',
'customerDetails.countryCode' => 'required|nullable|string',
'customerDetails.msisdn' => 'required|nullable|string',
'customerDetails.email' => 'required|nullable|email',
'customerDetails.name' => 'required|string',
'customerDetails.preferredLanguage' => 'required|string',
'customerDetails.personalNumber' => 'nullable|string|regex:/^\d{11}$/',
'customerDetails.organizationId' => 'required_if:customerDetails.type,corporate|nullable|string|regex:/^\d{9}$/',
'customerDetails.address' => 'required|array',
'customerDetails.address.street' => 'required|string',
'customerDetails.address.zip' => 'required|string',
'customerDetails.address.city' => 'required|string',
'customerDetails.address.country' => 'required|string|in:ISO Alpha 2',
'invoiceReferences' => 'nullable|array',
'invoiceReferences.referenceNo' => 'nullable|string',
'invoiceReferences.customerReference' => 'nullable|string',
'invoiceReferences.receiptNo' => 'nullable|string',
'invoiceReferences.customerNotes' => 'nullable|string',
'invoiceReferences.tnc' => 'nullable|string',
'invoiceInterval' => 'sometimes|numeric|in:0,1,2',
'separateInvoices' => 'sometimes|boolean',
'invoiceFeeApplicable' => 'sometimes|boolean',
'invoiceMaturity' => 'sometimes|numeric',
'internalReferences' => 'nullable|array',
'internalReferences.referenceNo' => 'nullable|string',
'internalReferences.notes' => 'nullable|string'

~~About Payload~~

Authentication

~~invoiceInterval~~,This ~~Daily~~endpoint ~~= 0, Once~~requires a ~~month~~Bearer =Token 1,for ~~Twice~~authentication. aYou ~~month~~will =need 2.to obtain this token from Frontpayment and include it in the Authorization header of your request.

~~invoiceMaturity~~Example Authorization Header:, ~~Default~~Authorization: valueBearer isYOUR_FRONTPAID_BEARER_TOKEN

~~10.~~

Request ifPayload

~~you~~

The ~~want~~request tobody ~~set~~should be a JSON object containing details about the ~~value~~products, ~~then~~order ~~give~~and ~~your value between 0 to 10.~~customer.

~~Example Payload~~

{
    "products": {
        "0": {
            "name": "Hair Wash",
            "productId": "VFDDF",
            "quantity": "1",
            "rate": 51,
            "discount": 0,
            "tax": "0",
            "amount": 51
        }
    },
    "orderSummary": {
        "subTotal": "51.00",
        "totalTax": "0.00",
        "totalDiscount": "0.00",
        "grandTotal": "51.00"
    },
    "orderDate": "1754928405",
    "dueDateForPaymentLink": "1703040812",
    "sendOrderBy": {
        "sms": false,
        "email": false,
        "invoice": true
    },
    "invoiceAsPaymentOption": false,
    "isCreditCheckAvailable": false,
    "customerDetails": {
        "type": "private",
        "countryCode": "+47",
        "msisdn": "46567468",
        "email": "[email protected]",
        "customerUuid": "CSRT3672053467",
        "name": "Kari Nordmann",
        "preferredLanguage": "en",
        "personalNumber": null,"12345678901,
        "organizationId": null,
        "address": {
            "street": "Luramyrveien 65",
            "zip": "4313",
            "city": "Sandnes",
            "country": "NO"
        }
    },
    "invoiceReferences": {
        "referenceNo": "Dhaka",
        "customerReference": "3500",
        "receiptNo": "Cumilla",
        "customerNotes": "NO",
        "tnc": "adfsl"
    },
    "invoiceInterval": 0,
    "invoiceMaturity": 10,
    "invoiceFeeApplicable": true,
    "separateInvoices": true,
    "internalReferences"referenceNo": null,
    "customerReference": null,
    "callback": {
        "referenceNo"callbackUrl": "Dhaka",
        "notes": "3500"https://example.com/callback-url"
    }
}

Validation Rules

Make sure your request meets the following requirements:

Field	Type	Description
`products.*.name`	`required` \| `string`	Required. Name of the product.
~~Response Structure~~`products.*.productId`	:`nullable` \| `string`	Nullable. `{Unique "status_code":identifier 201,for "status_message":the "OK", "message": "orderAddedSuccessfully", "is_data": true, "data": "Array" } { "status_code": 500, "status_message": "Internal Dependency Error", "message": "internalErrorOccurredPleaseTryAgainLater", "is_error": true, "errors": { "happenedAt": "String" "internalErrorDetails": "Array" } } { "status_code": 510, "status_message": "Execution Exception Occurred", "message": "somethingWentWrong", "is_error": true, "errors": "Array" }` product.
~~Example Response~~`products.*.quantity`	:`required` \| `numeric`	Required. Quantity of the product.
`products.*.rate`	`required` \| `numeric`	Required. Rate per unit of the product.
`products.*.discount`	`nullable` \| `numeric`	Nullable. Discount applied to the product.
`products.*.tax`	`required` \| `numeric`	Required. Tax rate
`products.*.amount`	`required` \| `numeric`	Required. Total amount for the product line item.
`orderSummary.subTotal`	`required` \| `numeric`	Required. Subtotal of all products before tax and discount.
`orderSummary.totalTax`	`required` \| `numeric`	Required. Total tax for the order.
`orderSummary.totalDiscount`	`required` \| `numeric`	Required. Total discount for the order.
`orderSummary.grandTotal`	`required` \| `numeric`	Required. Grand total of the order.
`orderDate`	`required` \| `string`	Required. Unix timestamp for the Date of the order.
`customerDetails.countryCode`	`required` \| `string`	Required. Country code for the customer's phone number (e.g., "+47").
`customerDetails.msisdn`	`required` \| `string`	Required. Mobile Subscriber ISDN Number (phone number).
`customerDetails.email`	`required` \| `email`	Required. Customer's email address.
`customerDetails.name`	`required` \| `string`	Required. Customer's full name.
`customerDetails.preferredLanguage`	`nullable` \| `string`	Nullable. Customer's language (e.g., `NO`, `EN`). Default value = `NO`
`customerDetails.type`	`required` \| `string`	Required. You can provide customer type is `private` or `corporate`
`customerDetails.personalNumber`	`required` \| `string` \| `max:11`	Conditional Required. Customer's personal identification number, must be 11 characters. When Customer type is `private` then this field is required.
`customerDetails.organizationId`	`required` \| `string` \| `max:9`	Conditional Required. Organization identification number, must be 9 characters. When Customer type is `corporate` then this field is required.
`customerDetails.address.street`	`required` \| `string`	Required. Street address of the customer.
`customerDetails.address.zip`	`required` \| `string`	Required. Zip code of the customer's address.
`customerDetails.address.city`	`required` \| `string`	Required. City of the customer's address.
`customerDetails.address.country`	`required` \| `string`	Required. ISO Alpha-2 country code (e.g., `NO`). Custom validation `IsoAlpha2Country` applies.
`invoiceInterval`	`sometimes` \| `numeric`	Optional. Default value is = `0`. You can change it to `0`, `1`, `2`. Daily = `0`, Once a month = `1`, Twice a month = `2`.
`invoiceFeeApplicable`	`required` \| `boolean`	Required. Default value is `true`.
`invoiceMaturity`	`sometimes` \| `numeric`	Optional. Default value is `10`. if you want to set the value then give your value `0` or `10`.
`separateInvoices`	`sometimes` \| `boolean`	Optional. Default value is `true`.
`referenceNo`	`nullable` \| `string`	Nullable. Any reference number.
`customerReference`	`nullable` \| `string`	Nullable. Any value for customer reference .
`callback.callbackUrl`	`required` \| `array`	Required. The URL we will notify when order status changes.

Response

A successful request will return a 201 Created status with the following JSON payload:

{
    "status_code": 201,
    "status_message": "OK",
    "message": "orderAddedSuccessfully",
    "is_data": false,
    "data": {
        "uuid": "ODR3506777330",
        "customerUuid": "CSRT3463048878"
    }
}

500 or 510 error, it means something failed on the server side

{
    "status_code": 500,
    "status_message": "Internal Dependency Error",
    "message": "internalErrorOccurredPleaseTryAgainLater",
    "is_error": true,
    "errors": {
        "happenedAt": "String",
        "internalErrorDetails": "Array"
    }
}

{
    "status_code": 510,
    "status_message": "Execution Exception Occurred",
    "message": "somethingWentWrong",
    "is_error": true,
    "errors": "Array"
}