Get a Financial Document

This service returns detail of the Invoice document for the given Document Reference, Document Id or by Job Id.

Query String Parameters

Name	Type	Description	Required
Action	String	FinancialDoc	Required
JobId	Int	BigChange job Id.	Required - see note.
DocId	Int	BigChange document Id.	Required - see note.
DocRef	String	BigChange document reference.	Required - see note.
IncludeCancelled	Bool	Include cancelled documents in the result. Defaults to false.	Optional
IncludeAllDocTypes	Bool	Include invoice documents of all types, not just invoices. Defaults to false.	Optional

note

Supply either JobId, DocId or DocRef.

If JobId is supplied, it will take precedence over DocId or DocRef. DocId takes precedence over DocRef.

tip

Using the Document Reference or Document Id will return a single document.

Using the Job Id parameter can return multiple documents.

Response Codes

Example

Request

Request URL

https://webservice.bigchange.com/v01/services.ashx?action=financialdoc

Response

Response Data

{
  "Code": 0,
  "Result": [
    {
      "JourneyId": "12345",
      "StartTime": "2024-08-18T08:00:00Z",
      "EndTime": "2024-08-18T10:00:00Z",
      "StartLocation": "Location A",
      "EndLocation": "Location B",
      "Distance": 25.6,
      "Unit": "kilometers"
    }
  ]
}