Mark Paid

Beta: Mark paid

Mark an invoice as paid

POSThttps://api.dashdoc.eu/api/v4/invoices/{uid}/mark-paid/

Path parameters

uid*string (uuid)

Response

200

Body

application/json

uidstring (uuid)

uuid of this Invoice

Example: "687cddac-dbd2-11ea-9024-0242ac130006"

created_byInvoiceCreatedBy (object)

debtorInvoiceDebtor (object)

description_templateobject

Ignore. Dashdoc technical data.

document_numberstring

Invoice's number. It usually corresponds to the invoice's number defined in your invoicing tool.

Example: "20211125-11"

statusenum

Indicate the status of the invoice

draftfinalpaid

due_datenullable string (date)

Due date of the invoice

Example: "2020-07-30"

line_groupsarray of InvoiceLineGroup (object)

linesarray of InvoiceLine (object)

List of lines of the invoice which do not correspond to a transport

createdcreated (string (date-time))

Date of creation on our server

Example: "2020-12-22T15:31:39.26167Z"

updatedstring (date-time)

Last update on our server

periodInvoice_period (object)

The interval between the date of first loading and last unloading among all the transports of the invoice.

transports_countinteger

Number of transports linked to this invoice

Example: 2

remote_idstring

The id of the invoice in your system.

Example: "COMP_123_INV_1"

invoicing_connectorobject

Ignore. Dashdoc technical data.

filestring (url)

Invoice file path

Example: "https://storage.googleapis.com/dashdoc-media/media/invoices/aabd42eb.png"

invoicing_datestring (date)

Date of invoicing

Example: "2022-05-24"

finalized_atstring (date-time)

Date of invoice finalization.

Example: "2021-12-14T18:23:44.648232Z"

debtor_referencestring

Pre-billing reference

Example: "D_PreBillingREF1"

total_pricestring

Total price, excluding taxes

Example: "100.00"

total_tax_amountstring

Total taxes amount

Example: "100.00"

Request

JavaScriptCurlPython

const response = await fetch('https://api.dashdoc.eu/api/v4/invoices/{uid}/mark-paid/', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

200

{
  "uid": "687cddac-dbd2-11ea-9024-0242ac130006",
  "created_by": {
    "pk": 928,
    "name": "Transport Bouvet",
    "primary_address": {
      "pk": "text",
      "name": "Transport Bouvet",
      "address": "3 rue des champs",
      "city": "Nantes",
      "postcode": "44000",
      "country": "FR",
      "latitude": -52.5561625,
      "longitude": 92.896504,
      "radius": 500,
      "coords_validated": false,
      "is_demo": false,
      "is_carrier": false,
      "is_shipper": false,
      "is_origin": false,
      "is_destination": false,
      "created_by": 0,
      "created": "2020-07-30T21:10:06.44551Z",
      "instructions": "text",
      "remote_id": "text"
    },
    "country": "FR",
    "vat_number": "text"
  },
  "debtor": {
    "pk": 928,
    "invoicing_remote_id": "text",
    "name": "Transport Bouvet",
    "primary_address": {
      "pk": "text",
      "name": "Transport Bouvet",
      "address": "3 rue des champs",
      "city": "Nantes",
      "postcode": "44000",
      "country": "FR",
      "latitude": -52.5561625,
      "longitude": 92.896504,
      "radius": 500,
      "coords_validated": false,
      "is_demo": false,
      "is_carrier": false,
      "is_shipper": false,
      "is_origin": false,
      "is_destination": false,
      "created_by": 0,
      "created": "2020-07-30T21:10:06.44551Z",
      "instructions": "text",
      "remote_id": "text"
    },
    "country": "FR",
    "vat_number": "text"
  },
  "document_number": "20211125-11",
  "status": "draft",
  "due_date": "2020-07-30",
  "line_groups": [
    {
      "transport": {
        "uid": "d6e95574-8c1f-4b97-bdea-f20d0eb4f7f0",
        "sequential_id": 38332787,
        "deliveries": [
          {
            "uid": "d31bf46b-2175-4d1c-aae3-f0f0162e43c4",
            "origin": {
              "uid": "text",
              "company_name": "Graillet",
              "city": "Gap"
            },
            "destination": {
              "uid": "text",
              "company_name": "Graillet",
              "city": "Gap"
            }
          }
        ],
        "documents": [
          {
            "delivery": "d31bf46b-2175-4d1c-aae3-f0f0162e43c4",
            "file": "text",
            "reference": "3861546",
            "category": "text"
          }
        ],
        "messages": [
          {
            "document": "text",
            "reference": "REF_123",
            "document_type": "load_photo"
          }
        ]
      },
      "lines": [
        {
          "description": "Unité de facturation : Forfait",
          "quantity": 1,
          "unit_price": 0,
          "currency": "EUR",
          "total_price_without_tax": 10,
          "invoice_item": {
            "uid": "687cddac-dbd2-11ea-9024-0242ac130006",
            "remote_id": "ITEM_123",
            "description": "Gas transportation"
          },
          "is_gas_indexed": false
        }
      ],
      "description": "Transport N°3833279\nNuméro de LV : 3861546\nChargement : Graillet , 3 Chemin de la Carrière, 05000 Gap, FR\nLivraison : Perret, 6 Rue du Petit Bois, 52300 Suzannecourt, FR",
      "currency": "EUR",
      "gas_index": "text",
      "gas_index_invoice_item": {
        "uid": "687cddac-dbd2-11ea-9024-0242ac130006",
        "remote_id": "ITEM_123",
        "description": "Gas transportation"
      }
    }
  ],
  "lines": [
    {
      "description": "Unité de facturation : Forfait",
      "quantity": 1,
      "unit_price": 0,
      "currency": "EUR",
      "total_price_without_tax": 10,
      "invoice_item": {
        "uid": "687cddac-dbd2-11ea-9024-0242ac130006",
        "remote_id": "ITEM_123",
        "description": "Gas transportation"
      },
      "is_gas_indexed": false
    }
  ],
  "created": "2020-12-22T15:31:39.26167Z",
  "updated": "2024-12-07T14:16:09.830Z",
  "period": {
    "first_loading_at": "2021-12-13T18:23:44.648232Z",
    "last_unloading_at": "2021-12-14T18:23:44.648232Z"
  },
  "transports_count": 2,
  "remote_id": "COMP_123_INV_1",
  "file": "https://storage.googleapis.com/dashdoc-media/media/invoices/aabd42eb.png",
  "invoicing_date": "2022-05-24",
  "finalized_at": "2021-12-14T18:23:44.648232Z",
  "debtor_reference": "D_PreBillingREF1",
  "total_price": "100.00",
  "total_tax_amount": "100.00"
}