jobs/{id}/cost

This method returns word count and cost information for Codyt jobs.

URL

(GET) /api/jobs/{id}/cost

PARAMETERS

The URL parameters are:

id

The job ID. Also see jobs/{id}/summary

string, Mandatory

RESULTS

The result is a JSON object with these properties:

cost	The cost details. See https://wordbee.atlassian.net/wiki/spaces/API2/pages/2486960129 for details.	object
counts	The word count details. See https://wordbee.atlassian.net/wiki/spaces/API2/pages/2486894638 for details.	object
properties	Additional information, see below	object

The properties node has these elements:

locs	Source language code.	string
loct	Target language code.	string
branch	Branch locale code.	string
task	The job task code.	string
did	The document ID	int
wcid	The word count record ID	int
invoiceId	If job is included in an invoice.	int?
paragraphFrom	Null or the first paragraph that the job covers. This can be used to split a document into multiple jobs.	int?
paragraphTo	Null or the last paragraph that the job covers.	int?
paragraphs	Total paragraphs in job. A paragraph may be split into 1 or more segments. If no segmentation of a document takes place then the number of paragraphs is identical to the number of segments (such as shown in the translation editor).	int

EXAMPLE

A payload may look like:

{
    "cost": {
        "total": 495.00,
        "totalBase": 1000.00,
        "reduction": {
            "amount": 100.00,
            "percent": 10.0,
            "subTotal": 900.00
        },
        "fee": {
            "amount": 90.00,
            "percent": 10.0,
            "subTotal": 990.00
        },
        "covered": {
            "percent": 50.0,
            "subTotal": 495.00
        },
        "currency": "USD",
        "decimals": 2
    },
    "counts": {
        "date": "2023-12-19T12:44:28.28Z",
        "general": {
            "segments": 1,
            "words": 2,
            "chars": 5,
            "pages": null,
            "minutes": null,
            "wordsExcluded": 0,
            "charsTranslated": null,
            "wordsTranslated": null,
            "wdPretransIdentical": 0,
            "wdPretransIdenticalCtx": 0,
            "wdPretransIdenticalPrevCtx": 0,
            "wdPretransIdenticalPrev": 0,
            "wdPretransIdenticalMT": 0,
            "wdPretransFuzzy": 0,
            "wd110": 0,
            "wd100": 0,
            "wdMatch1": 0,
            "wdMatch2": 0,
            "wdMatch3": 0,
            "wdMatch4": 0,
            "wdMatch5": 0,
            "tags": 0,
            "spaces": 1,
            "punctuation": 0,
            "nonAsianWords": 0,
            "asianCharacters": 0
        },
        "words": {
            "isNullCounts": false,
            "total": 2.0,
            "excluded": 0,
            "pretransIdentical": 0,
            "pretransIdenticalCtx": 0,
            "pretransIdenticalPrevCtx": 0,
            "pretransIdenticalPrev": 0,
            "pretransIdenticalMT": 0,
            "pretransIdenticalOther": 0,
            "pretrans110": 0,
            "pretrans100": 0,
            "pretransFuzzy": 0,
            "match1": 0,
            "match2": 0,
            "match3": 0,
            "match4": 0,
            "match5": 0,
            "noMatch": 2.0
        },
        "chars": {
            "isNullCounts": false,
            "total": 5.0,
            "excluded": 0,
            "pretransIdentical": 0,
            "pretransIdenticalCtx": 0,
            "pretransIdenticalPrevCtx": 0,
            "pretransIdenticalPrev": 0,
            "pretransIdenticalMT": 0,
            "pretransIdenticalOther": 0,
            "pretrans110": 0,
            "pretrans100": 0,
            "pretransFuzzy": 0,
            "match1": 0,
            "match2": 0,
            "match3": 0,
            "match4": 0,
            "match5": 0,
            "noMatch": 5.0
        },
        "intervals": [
            {
                "min": 110,
                "max": 110
            },
            {
                "min": 100,
                "max": 109
            },
            {
                "min": 75,
                "max": 99
            }
        ]
    },
    "properties": {
        "locs": "en",
        "loct": "es",
        "branch": "es",
        "task": "TR",
        "did": 18325,
        "wcid": 19590,
        "invoiceId": null,
        "paragraphFrom": null,
        "paragraphTo": null,
        "paragraphs": 1
    }
}