Support for

FLAPI: Job Finances

John Valentine
by John Valentine 9 years ago
 

Contents

  • List finance lines by job id and costing id
  • Add a finance lines to a job
  • Change a finance line
  • Remove a finance line

List finances by job id and costing id

GET path
/jobs/<job.id>/finances/<costing.id>

Retrieves the requested job finance lines, which are the items that comprise the total charge, e.g. individual goods and services.

Note that the costing.id is case sensitive, so the example below would fail with pr as an argument.
Parameter Description
format json or xml
HTTP request
GET http://dev.flyerlink.com/api.php/jobs/266386/finances/PR?format=json
HTTP response (JSON)
{
    "finance" : {
        "job" : "266386",
        "costing" : "PR",
        "quantity" : "5000",
        "units" : "500",
        "unitcost" : "69.00",
        "unitrev" : "39.00",
        "cost" : "217.35",
        "revenue" : "390.00",
        "prcost" : "0.00",
        "unitprcost" : "0.00",
        "vat" : "20.00",
        "vatcode" : "1",
        "vattotal" : "78.000",
        "name" : "PRINTING",
        "customname" : null,
        "voucher" : "f",
        "template" : "f"
    }
}

Add finances to job

POST path
/jobs/<job.id>/finances

Adds a job finance line. Returns an error message if a line with matching <job.id> and <costing.code>​ already exists.

Parameter Description
format json or xml
costing (required) costing.code.
revenue (required) currency amount for the Selling Price.
HTTP request
POST http://dev.flyerlink.com/api.php/jobs/266386/finances
costing=AAA&revenue=56&format=xml

Change a job finance line

PUT path
/jobs/<job.id>/finances/<costing.code>

Changes a job finance line.

Parameter Description
format json or xml
revenue (required) currency amount for the Selling Price.
HTTP request
PUT http://dev.flyerlink.com/api.php/jobs/266386/finances/C?revenue=56&format=xml

Delete a job finance line

DELETE path
/jobs/<job.id>/finances/<costing.code>

Removes the existing job finance line that matches <job.id> and <costing.code>.

Parameter Description
format json or xml
HTTP request
DELETE http://dev.flyerlink.com/api.php/jobs/2247469/finances/AAA&format=xml
 

Jump to contents page of

FLAPI: Jobs

 
 
 

All content is (c) Nettl Systems Limited, 2024 and may not be used, copied or distributed without permission.