Add New Invoice Payment

curl --location -g --request POST 'https://.daftra.com/api2/invoice_payments' \ --header 'Accept: application/json' \ --header 'Authorization: Bearer ' \ --header 'apikey: ' \ --header 'Content-Type: application/json' \ --data-raw '{ "InvoicePayment": { "invoice_id": 0, "payment_method": "string", "amount": 0, "transaction_id": "string", "treasury_id": 0, "date": "2019-08-24T14:15:22Z", "email": "string", "status": 0, "notes": "string", "response_code": "string", "response_message": "string", "created": "2019-08-24T14:15:22Z", "modified": "2019-08-24T14:15:22Z", "currency_code": "str", "first_name": "string", "last_name": "string", "address1": "string", "address2": "string", "city": "string", "state": "string", "postal_code": "string", "country_code": "str", "phone1": "string", "phone2": "string", "transaction_type": "string", "processed": true, "attachment": "string", "staff_id": 0, "receipt_notes": "string" } }'

Request

Path Params

format

string

required

Header Params

string

optional

Default:

application/json

Content-Type

string

optional

Default:

application/json

Authorization

string

optional

You can generate the bearer token using the the authorization endpoint then use it here to be able to operate over your account's data

Default:

Bearer {{access_token}}

apikey

string

deprecated

You can find/generate your apikey(s) from inside your Daftra Account

Default:

Body Params application/json

InvoicePayment

object

PaymentBase

optional

invoice_id

integer <int64>

required

Invoice REF#, you can get it through the Invoices API

payment_method

string

required

Method of payment

<= 100 characters

amount

number <double>

required

Amount paid

transaction_id

string

optional

Visual identifier for the process

<= 100 characters

treasury_id

integer

optional

Treasury Ref get it from GET Treasuries

date

string <date-time>

optional

date of the payment

string

optional

Optional Email

<= 255 characters

status

integer <int32>

optional

Status of the payment 0=>failded, 1=>completed , 2=>pending, 3=>not completed

notes

string

optional

Notes for payment

response_code

string

optional

Response code of the API called ex:(stripe , paypal , .. )

response_message

string

optional

Response message of the API called ex:(stripe , paypal , .. )

created

string <date-time>

optional

Time of creation for the client

modified

string <date-time>

optional

Last Time this Payment was updated

currency_code

string

optional

3 Digit currency code following ISO 4217 standard

<= 3 characters

first_name

string

optional

First Name (Extra Info)

<= 255 characters

last_name

string

optional

Last name (Extra Info)

<= 255 characters

address1

string

optional

Address line 1 (Extra Info)

<= 255 characters

address2

string

optional

Address line 2 (Extra Info)

<= 255 characters

city

string

optional

City (Extra Info)

<= 255 characters

state

string

optional

State (Extra Info)

<= 100 characters

postal_code

string

optional

Postal code (Extra Info)

<= 10 characters

country_code

string

optional

Country ISO "ALPHA-2" Code (Extra Info)

<= 3 characters

phone1

string

optional

Phone number (Extra Info)

<= 50 characters

phone2

string

optional

Mobile number (Extra Info)

<= 50 characters

transaction_type

string

optional

<= 255 characters

processed

boolean

optional

0/1 if the payment is processed

attachment

string

optional

Link for the attachment

<= 255 characters

staff_id

integer <int32>

optional

Staff user submitting the request get it from GET STAFF API if it's 0 that means the site owner is the staff that created it

receipt_notes

string

optional

Notes for the receipt .

Examples

Created

Add New Invoice Payment

Request

Responses