GET

Description

Retrieves a list of supplier invoice payments or a single supplier invoice payment.

URL structure

https://api.fortnox.se/3/supplierinvoicepayments/{Number}

Method

GET

Version

3

Response

The supplier invoice payments register can return a list of records or a single record. By specifying a Number in the URL, a single record will be returned. Not specifying a Number will return a list of records.

<?xml version="1.0" encoding="UTF-8"?>
<SupplierInvoicePayments TotalResources="3" TotalPages="1" CurrentPage="1">
  <SupplierInvoicePaymentSubset url="https://api.fortnox.se/3/supplierinvoicepayments/3">
    <Amount>99</Amount>
    <Booked>false</Booked>
    <Currency>SEK</Currency>
    <CurrencyRate>1</CurrencyRate>
    <CurrencyUnit>1</CurrencyUnit>
    <InvoiceNumber>1</InvoiceNumber>
    <Number>3</Number>
    <Source>manual</Source>
  </SupplierInvoicePaymentSubset>

  [...]

  <SupplierInvoicePaymentSubset url="https://api.fortnox.se/3/supplierinvoicepayments/1">
    <Amount>99</Amount>
    <Booked>false</Booked>
    <Currency>SEK</Currency>
    <CurrencyRate>1</CurrencyRate>
    <CurrencyUnit>1</CurrencyUnit>
    <InvoiceNumber>1</InvoiceNumber>
    <Number>1</Number>
    <Source>manual</Source>
  </SupplierInvoicePaymentSubset>
</SupplierInvoicePayments>
<?xml version="1.0" encoding="UTF-8"?>
<SupplierInvoicePayment url="https://api.fortnox.se/3/supplierinvoicepayments/1">
  <Amount>99</Amount>
  <AmountCurrency>99</AmountCurrency>
  <Booked>false</Booked>
  <Currency>SEK</Currency>
  <CurrencyRate>1</CurrencyRate>
  <CurrencyUnit>1</CurrencyUnit>
  <Information></Information>
  <InvoiceNumber>1</InvoiceNumber>
  <InvoiceDueDate>2014-03-14</InvoiceDueDate>
  <InvoiceOCR></InvoiceOCR>
  <InvoiceSupplierName>Telefoniföretaget AB</InvoiceSupplierName>
  <InvoiceSupplierNumber>1</InvoiceSupplierNumber>
  <InvoiceTotal>10000</InvoiceTotal>
  <ModeOfPayment></ModeOfPayment>
  <Number>1</Number>
  <PaymentDate>2014-03-14</PaymentDate>
  <Source>manual</Source>
  <VoucherNumber></VoucherNumber>
  <VoucherSeries></VoucherSeries>
  <VoucherYear></VoucherYear>
  <WriteOffs/>
</SupplierInvoicePayment>
{
  "MetaInformation": {
    "@TotalResources": 3,
    "@TotalPages": 1,
    "@CurrentPage": 1
  },
  "SupplierInvoicePayments": [
    {
      "@url": "https://api.fortnox.se/3/supplierinvoicepayments/3",
      "Amount": 99,
      "Booked": false,
      "Currency": "SEK",
      "CurrencyRate": 1,
      "CurrencyUnit": 1,
      "InvoiceNumber": "1",
      "Number": 3,
      "Source": "manual"
    },

    [...]

    {
      "@url": "https://api.fortnox.se/3/supplierinvoicepayments/1",
      "Amount": 99,
      "Booked": false,
      "Currency": "SEK",
      "CurrencyRate": 1,
      "CurrencyUnit": 1,
      "InvoiceNumber": "1",
      "Number": 1,
      "Source": "manual"
    }
  ]
}
{
  "SupplierInvoicePayment": {
    "@url": "https://api.fortnox.se/3/supplierinvoicepayments/1",
    "Amount": 99,
    "AmountCurrency": 99,
    "Booked": false,
    "Currency": "SEK",
    "CurrencyRate": 1,
    "CurrencyUnit": 1,
    "Information": null,
    "InvoiceNumber": "1",
    "InvoiceDueDate": "2014-03-14",
    "InvoiceOCR": "",
    "InvoiceSupplierName": "Telefoniföretaget AB",
    "InvoiceSupplierNumber": "1",
    "InvoiceTotal": "10000",
    "ModeOfPayment": "",
    "Number": 1,
    "PaymentDate": "2014-03-14",
    "Source": "manual",
    "VoucherNumber": null,
    "VoucherSeries": null,
    "VoucherYear": null,
    "WriteOffs": []
  }
}

POST

Description

Creates a supplier invoice payment.

URL structure

https://api.fortnox.se/3/supplierinvoicepayments

Method

POST

Version

3

Request

The request body should contain a structure of a supplier invoice payment, either in JSON or XML.

<SupplierInvoicePayment>
  <Amount>99</Amount>
  <InvoiceNumber>1</InvoiceNumber>
</SupplierInvoicePayment>
{
  "SupplierInvoicePayment": {
    "Amount": 99,
    "InvoiceNumber": 1
  }
}

Response

The response should contain the created supplier invoice payment in either JSON or XML.

<?xml version="1.0" encoding="UTF-8"?>
<SupplierInvoicePayment url="https://api.fortnox.se/3/supplierinvoicepayments/3">
  <Amount>99</Amount>
  <AmountCurrency>99</AmountCurrency>
  <Booked>false</Booked>
  <Currency>SEK</Currency>
  <CurrencyRate>1</CurrencyRate>
  <CurrencyUnit>1</CurrencyUnit>
  <Information></Information>
  <InvoiceNumber>1</InvoiceNumber>
  <InvoiceDueDate>2014-03-14</InvoiceDueDate>
  <InvoiceOCR></InvoiceOCR>
  <InvoiceSupplierName>Telefoniföretaget AB</InvoiceSupplierName>
  <InvoiceSupplierNumber>1</InvoiceSupplierNumber>
  <InvoiceTotal>10000</InvoiceTotal>
  <ModeOfPayment></ModeOfPayment>
  <Number>3</Number>
  <PaymentDate>2014-03-14</PaymentDate>
  <Source>manual</Source>
  <VoucherNumber></VoucherNumber>
  <VoucherSeries></VoucherSeries>
  <VoucherYear></VoucherYear>
  <WriteOffs/>
</SupplierInvoicePayment>
{
  "SupplierInvoicePayment": {
    "@url": "https://api-draken.alfa.fortnox.local/3/supplierinvoicepayments/2",
    "Amount": 99,
    "AmountCurrency": 99,
    "Booked": false,
    "Currency": "SEK",
    "CurrencyRate": 1,
    "CurrencyUnit": 1,
    "Information": null,
    "InvoiceNumber": 1,
    "InvoiceDueDate": "2014-03-14",
    "InvoiceOCR": "",
    "InvoiceSupplierName": "Telefoniföretaget AB",
    "InvoiceSupplierNumber": "1",
    "InvoiceTotal": "10000",
    "ModeOfPayment": "",
    "Number": 2,
    "PaymentDate": "2014-03-14",
    "Source": "manual",
    "VoucherNumber": null,
    "VoucherSeries": null,
    "VoucherYear": null,
    "WriteOffs": []
  }
}

PUT

Description

Updates a supplier invoice payment.

URL structure

https://api.fortnox.se/3/supplierinvoicepayments/{Number}

Method

PUT

Version

3

Request

The request body should contain a structure of a supplier invoice payment, either in JSON or XML.

<SupplierInvoicePayment>
  <Amount>99</Amount>
  <InvoiceNumber>1</InvoiceNumber>
  <ModeOfPayment>BG</ModeOfPayment>
</SupplierInvoicePayment>
{
  "SupplierInvoicePayment": {
    "Amount": 99,
    "InvoiceNumber": 1,
    "ModeOfPayment": "BG"
  }
}

Response

The response should contain the updated supplier invoice payment in either JSON or XML.

<?xml version="1.0" encoding="UTF-8"?>
<SupplierInvoicePayment url="https://api.fortnox.se/3/supplierinvoicepayments/2">
  <Amount>99</Amount>
  <AmountCurrency>99</AmountCurrency>
  <Booked>false</Booked>
  <Currency>SEK</Currency>
  <CurrencyRate>1</CurrencyRate>
  <CurrencyUnit>1</CurrencyUnit>
  <Information></Information>
  <InvoiceNumber>1</InvoiceNumber>
  <InvoiceDueDate>2014-03-14</InvoiceDueDate>
  <InvoiceOCR></InvoiceOCR>
  <InvoiceSupplierName>Telefoniföretaget AB</InvoiceSupplierName>
  <InvoiceSupplierNumber>1</InvoiceSupplierNumber>
  <InvoiceTotal>10000</InvoiceTotal>
  <ModeOfPayment></ModeOfPayment>
  <Number>2</Number>
  <PaymentDate>2014-03-14</PaymentDate>
  <Source>manual</Source>
  <VoucherNumber></VoucherNumber>
  <VoucherSeries></VoucherSeries>
  <VoucherYear></VoucherYear>
  <WriteOffs/>
</SupplierInvoicePayment>
{
  "SupplierInvoicePayment": {
    "@url": "https://api.fortnox.se/3/supplierinvoicepayments/2",
    "Amount": 99,
    "AmountCurrency": 99,
    "Booked": false,
    "Currency": "SEK",
    "CurrencyRate": 1,
    "CurrencyUnit": 1,
    "Information": null,
    "InvoiceNumber": "1",
    "InvoiceDueDate": "2014-03-14",
    "InvoiceOCR": "",
    "InvoiceSupplierName": "Telefoniföretaget AB",
    "InvoiceSupplierNumber": "1",
    "InvoiceTotal": "10000",
    "ModeOfPayment": null,
    "Number": 2,
    "PaymentDate": "2014-03-14",
    "Source": "manual",
    "VoucherNumber": null,
    "VoucherSeries": null,
    "VoucherYear": null,
    "WriteOffs": []
  }
}

DELETE

Description

Removes a supplier invoice payment.

URL structure

https://api.fortnox.se/3/supplierinvoicepayments/{Number}

Method

DELETE

Version

3

Request

The request body should be empty.

Response

The response body should be empty.

Actions

Action name Description
bookkeep Bookkeeps the supplier invoice payment

For information about how to use actions, please read this article.

Fields

Invoice payment

Field Description Limits Type Searchable Sortable Required R/W
Url Direct URL to the record String R
Amount Amount of the payment Float Yes R/W
AmountCurrency Amount in the specified currency of the payment Float R/W
Booked If the payment is booked or not Boolean R
Currency Currency of the payment 3 characters String R
CurrencyRate The currency rate Float R/W
CurrencyUnit The currency unit Float R
Information Information about the payment String R/W
InvoiceNumber Invoice number Integer Yes Yes R/W
InvoiceDueDate Due date of the invoice Date R
InvoiceOCR OCR of the invoice String R/W
InvoiceSupplierName Name of the supplier String R
InvoiceSupplierNumber Number of the supplier String R
InvoiceTotal Invoice total Float R
ModeOfPayment Code of the mode of payment String R/W
Number Payment number Integer R
PaymentDate Date of the payment Date R/W
Source Payment source manual / direct String R
VoucherNumber Number of the voucher Integer R
VoucherSeries Series of the voucher String R
VoucherYear Id of the voucher year Integer R
WriteOffs[WriteOff]

Write off

Field Description Limits Type Searchable Sortable Required R/W
Amount Amount of the writeoff Float R/W
AccountNumber Account number of the write off 4 characters Integer R/W
CostCenter Code of the cost center String R/W
Currency Currency of the payment 3 characters String R
Description Description of the write off String R
TransactionInformationCode Code of the transaction information Integer R/W
Project Project number of the write off String R/W