Preview a self-billing

Designing

POST

/api/v3/provider/self-billings/previews

Request

Body Params application/jsonRequired

Examples

Responses

🟢200Success

application/json

Bodyapplication/json

Request Example

Shell

JavaScript

Java

Swift

curl --location '/api/v3/provider/self-billings/previews' \
--header 'Content-Type: application/json' \
--data '{
    "billingNumber": "SB-30-001",
    "currency": null,
    "buyer": {
        "sid": "string"
    },
    "seller": {
        "sid": "string"
    },
    "lineItems": [
        {
            "name": "string",
            "description": "string",
            "touchpointType": null,
            "touchpointQuantity": 0,
            "amount": {
                "amount": 0,
                "currencyCode": "string"
            },
            "billingStartDate": "2019-08-24",
            "billingEndDate": "2019-08-24",
            "type": {
                "code": "fee",
                "name": "Fee"
            },
            "feeType": {
                "code": "access"
            }
        }
    ],
    "issueDate": "2019-08-24",
    "saleDate": "2019-08-24",
    "type": {
        "code": "standard"
    }
}'

Response Example

{
    "sid": "125f8ec3-5699-46b1-aacf-9e20a232f057",
    "status": {
        "code": "proforma",
        "name": "string"
    },
    "title": "Self-Billing",
    "billingNumber": "SB-30-001",
    "currency": null,
    "buyer": {
        "sid": "string",
        "name": "string",
        "address": {
            "line1": "string",
            "line2": "string",
            "city": "string",
            "postalCode": "string",
            "country": "string"
        },
        "contact": {
            "email": "user@example.com",
            "phone": "string",
            "url": "http://example.com"
        },
        "businessId": "string",
        "vatId": "string"
    },
    "seller": {
        "sid": "string",
        "name": "string",
        "address": {
            "line1": "string",
            "line2": "string",
            "city": "string",
            "postalCode": "string",
            "country": "string"
        },
        "email": "user@example.com",
        "department": "string",
        "person": "string",
        "businessId": "string",
        "vatId": "string",
        "pricingType": "margin",
        "pricingMargin": 0,
        "pricingOverride": 0,
        "convertShare": 0,
        "extraData": "string"
    },
    "lineItems": [
        {
            "sid": "05e72abf-09bb-4d91-ab76-2ea47fbc40a2",
            "name": "string",
            "description": "string",
            "touchpointType": null,
            "touchpointQuantity": 0,
            "amount": {
                "amount": 0,
                "currencyCode": "string"
            },
            "billingStartDate": "2019-08-24",
            "billingEndDate": "2019-08-24",
            "createdBy": "string",
            "createdAt": "2019-08-24T14:15:22.123Z",
            "updatedBy": "string",
            "updatedAt": "2019-08-24T14:15:22.123Z",
            "type": {
                "code": "fee",
                "name": "Fee"
            },
            "feeType": {
                "code": "access"
            }
        }
    ],
    "payment": {
        "sid": "string",
        "type": "bankTransfer",
        "terms": "string",
        "fees": "string",
        "feesType": "string",
        "bankAccount": {
            "name": "string",
            "number": "string",
            "iban": "string",
            "swiftCode": "string",
            "routingNumber": "string",
            "routingCode": "string",
            "ifscCode": "string",
            "address": {
                "line1": "string",
                "line2": "string",
                "city": "string",
                "postalCode": "string",
                "country": "string"
            }
        },
        "paypalIdentifier": "string"
    },
    "issueDate": "2019-08-24",
    "saleDate": "2019-08-24",
    "dueDate": "2019-08-24",
    "subtotalAmount": {
        "amount": 0,
        "currencyCode": "string"
    },
    "paymentFeeAmount": {
        "amount": 0,
        "currencyCode": "string"
    },
    "taxAmount": {
        "amount": 0,
        "currencyCode": "string"
    },
    "totalAmount": {
        "amount": 0,
        "currencyCode": "string"
    },
    "notes": {
        "reference": "string",
        "courtesy": "Thank you for your business"
    },
    "footer": {
        "phone": "string",
        "url": "string"
    },
    "ksefNumber": "string",
    "ksefStatus": {
        "code": "string",
        "name": "string"
    },
    "pdf": {
        "url": "http://example.com"
    },
    "createdBy": {
        "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
        "displayName": "string"
    },
    "createdAt": "2019-08-24T14:15:22.123Z",
    "updatedBy": {
        "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
        "displayName": "string"
    },
    "updatedAt": "2019-08-24T14:15:22.123Z",
    "sentBy": {
        "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
        "displayName": "string"
    },
    "sentAt": "2019-08-24T14:15:22.123Z"
}

Modified at 2026-09-28 10:47:36

Create a self-billing

Update self-billing status to "Paid"