Credit Notes

Import credit note

This endpoint can be used to create or update (if externalId already exists) a credit note.

It cannot be used when using a native integration as credit notes are only created by the native integration in that case.

post/credit_notes

Request

Base URL
https://api.upflow.io/v1
Auth
API key in header X-Api-Key and API key in header X-Api-Secret

Request body

customIdstring required

Credit note custom identifier (e.g., document number).

externalIdstring

Credit note external identifier.

issuedAtstring date-time

The date at which the credit note was issued (ISO 8601 format).

dueDatestring date-time

The date when the credit note is due (ISO 8601 format). Often same as issuedAt.

namestring

The credit note name or description.

currency'EUR' | 'CHF' | 'USD' | 'CAD' | 'GBP' required

ISO 4217 Currency Code

grossAmountinteger required

Amount including taxes (in cents).

netAmountinteger required

Amount net of taxes (in cents).

updatedAtstring date-time

The date at which the credit note was last updated (ISO 8601 format).

Example request

{
  "customId": "CN123",
  "externalId": "92842AB37",
  "issuedAt": "2015-05-05T12:30:00Z",
  "dueDate": "2015-05-05T12:30:00Z",
  "name": "Credit Note for returned goods",
  "currency": "EUR",
  "grossAmount": 1700,
  "netAmount": 1500,
  "updatedAt": "2015-05-05T12:30:00Z",
  "customer": {
    "id": "00a70b35-2be3-4c43-aefb-397190134655",
    "externalId": "1a2c3b"
  },
  "linkedInvoices": [
    {
      "amountLinked": 2000,
      "invoice": {
        "id": "00a70b35-2be3-4c43-aefb-397190134655",
        "externalId": "92842AB37",
        "customId": "FAC123"
      }
    }
  ]
}

Response

Credit Note Created or Updated

customIdstring required

Credit note custom identifier (e.g., document number).

externalIdstring

Credit note external identifier.

issuedAtstring date-time

The date at which the credit note was issued (ISO 8601 format).

dueDatestring date-time

The date when the credit note is due (ISO 8601 format). Often same as issuedAt.

namestring

The credit note name or description.

currency'EUR' | 'CHF' | 'USD' | 'CAD' | 'GBP' required

ISO 4217 Currency Code

grossAmountinteger required

Amount including taxes (in cents).

netAmountinteger required

Amount net of taxes (in cents).

updatedAtstring date-time

The date at which the credit note was last updated (ISO 8601 format).

idstring uuid required

The Credit Note ID.

pdfUrlstring uri nullable

URL to the credit note PDF.

createdAtstring date-time

The date at which the credit note was created (ISO 8601 format).

Example response

{
  "customId": "CN123",
  "externalId": "92842AB37",
  "issuedAt": "2015-05-05T12:30:00Z",
  "dueDate": "2015-05-05T12:30:00Z",
  "name": "Credit Note for returned goods",
  "currency": "EUR",
  "grossAmount": 1700,
  "netAmount": 1500,
  "updatedAt": "2015-05-05T12:30:00Z",
  "id": "00a70b35-2be3-4c43-aefb-397190134655",
  "pdfUrl": "https://files.upflow.io/credit_note.pdf",
  "customer": {
    "id": "00a70b35-2be3-4c43-aefb-397190134655",
    "externalId": "1a2c3b",
    "companyName": "Upflow SAS",
    "accountingRef": "UPFL-SAS"
  },
  "linkedInvoices": [
    {
      "amountLinked": 2000,
      "invoice": {
        "id": "00a70b35-2be3-4c43-aefb-397190134655",
        "currency": "EUR",
        "amountOutstanding": 1500,
        "customId": "FAC123",
        "grossAmount": 2200,
        "netAmount": 2000,
        "name": "Facture couvrant les prestations de service de Decembre",
        "issuedAt": "2015-05-05T12:30:00Z",
        "dueDate": "2015-05-05T12:30:00Z",
        "paidDate": "2015-05-05T12:30:00Z",
        "externalId": "92842AB37"
      }
    }
  ],
  "createdAt": "2015-05-05T12:30:00Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.